@coveo/headless 3.29.2-pre.8dc80e7b9d → 3.29.2-pre.94d7ba76cf

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 (118) hide show
  1. package/dist/cjs/case-assist/headless.cjs +1 -1
  2. package/dist/cjs/commerce/headless.cjs +1 -1
  3. package/dist/cjs/headless.cjs +1 -1
  4. package/dist/cjs/insight/headless.cjs +1 -1
  5. package/dist/cjs/recommendation/headless.cjs +1 -1
  6. package/dist/cjs/ssr/headless.cjs +1 -1
  7. package/dist/cjs/ssr-commerce/headless.cjs +1 -1
  8. package/dist/cjs/ssr-commerce/node.cjs.stats.json +1 -1
  9. package/dist/cjs/ssr-commerce-next/headless.cjs +1 -1
  10. package/dist/cjs/ssr-commerce-next/node.cjs.stats.json +1 -1
  11. package/dist/cjs/ssr-next/headless.cjs +1 -1
  12. package/dist/definitions/ssr/common/types/hydrate-static-state.d.ts +4 -0
  13. package/dist/definitions/ssr-commerce-next.index.d.ts +3 -3
  14. package/dist/definitions/ssr-commerce.index.d.ts +1 -1
  15. package/dist/definitions/ssr-next/commerce/controller-utils.d.ts +1 -1
  16. package/dist/definitions/ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.d.ts +8 -4
  17. package/dist/definitions/ssr-next/commerce/engine/commerce-engine.ssr.d.ts +1 -2
  18. package/dist/definitions/ssr-next/commerce/factories/build-factory.d.ts +1 -5
  19. package/dist/definitions/ssr-next/commerce/factories/hydrated-state-factory.d.ts +1 -2
  20. package/dist/definitions/ssr-next/commerce/factories/recommendation-hydrated-state-factory.d.ts +1 -2
  21. package/dist/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts +1 -2
  22. package/dist/definitions/ssr-next/commerce/factories/static-state-factory.d.ts +1 -2
  23. package/dist/definitions/ssr-next/commerce/types/build.d.ts +58 -7
  24. package/dist/definitions/ssr-next/commerce/types/controller-definitions.d.ts +7 -122
  25. package/dist/definitions/ssr-next/commerce/types/controller-inference.d.ts +5 -10
  26. package/dist/definitions/ssr-next/commerce/types/engine.d.ts +10 -11
  27. package/dist/definitions/ssr-next/commerce/types/fetch-static-state.d.ts +3 -3
  28. package/dist/definitions/ssr-next/commerce/types/hydrate-static-state.d.ts +4 -4
  29. package/dist/definitions/ssr-next/commerce/utils/controller-wiring.d.ts +4 -7
  30. package/dist/definitions/ssr-next/commerce/utils/engine-wiring.d.ts +1 -2
  31. package/dist/definitions/ssr-next/commerce/utils/recommendation-filter.d.ts +14 -1
  32. package/dist/definitions/ssr-next/common/types/controller-inference.d.ts +6 -0
  33. package/dist/definitions/ssr-next/common/types/controllers.d.ts +0 -24
  34. package/dist/definitions/ssr-next/common/types/engine.d.ts +3 -45
  35. package/dist/definitions/ssr-next/common/types/utilities.d.ts +0 -3
  36. package/dist/definitions/ssr-next/{common → search}/controller-utils.d.ts +5 -5
  37. package/dist/definitions/ssr-next/search/controllers/breadcrumb-manager/headless-breadcrumb-manager.ssr.d.ts +1 -1
  38. package/dist/definitions/ssr-next/search/controllers/context/headless-context.ssr.d.ts +1 -1
  39. package/dist/definitions/ssr-next/search/controllers/dictionary-field-context/headless-dictionary-field-context.ssr.d.ts +1 -1
  40. package/dist/definitions/ssr-next/search/controllers/did-you-mean/headless-did-you-mean.ssr.d.ts +1 -1
  41. package/dist/definitions/ssr-next/search/controllers/facet-manager/headless-facet-manager.ssr.d.ts +1 -1
  42. package/dist/definitions/ssr-next/search/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.ssr.d.ts +1 -1
  43. package/dist/definitions/ssr-next/search/controllers/facets/category-facet/headless-category-facet.ssr.d.ts +1 -1
  44. package/dist/definitions/ssr-next/search/controllers/facets/facet/headless-facet.ssr.d.ts +1 -1
  45. package/dist/definitions/ssr-next/search/controllers/facets/range-facet/date-facet/headless-date-facet.ssr.d.ts +1 -1
  46. package/dist/definitions/ssr-next/search/controllers/facets/range-facet/date-facet/headless-date-filter.ssr.d.ts +1 -1
  47. package/dist/definitions/ssr-next/search/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.ssr.d.ts +1 -1
  48. package/dist/definitions/ssr-next/search/controllers/facets/range-facet/numeric-facet/headless-numeric-filter.ssr.d.ts +1 -1
  49. package/dist/definitions/ssr-next/search/controllers/field-suggestions/category-facet/headless-category-field-suggestions.ssr.d.ts +1 -1
  50. package/dist/definitions/ssr-next/search/controllers/field-suggestions/facet/headless-field-suggestions.ssr.d.ts +1 -1
  51. package/dist/definitions/ssr-next/search/controllers/folded-result-list/headless-folded-result-list.ssr.d.ts +1 -1
  52. package/dist/definitions/ssr-next/search/controllers/history-manager/headless-history-manager.ssr.d.ts +1 -1
  53. package/dist/definitions/ssr-next/search/controllers/instant-results/instant-results.ssr.d.ts +1 -1
  54. package/dist/definitions/ssr-next/search/controllers/pager/headless-pager.ssr.d.ts +1 -1
  55. package/dist/definitions/ssr-next/search/controllers/query-error/headless-query-error.ssr.d.ts +1 -1
  56. package/dist/definitions/ssr-next/search/controllers/query-summary/headless-query-summary.ssr.d.ts +1 -1
  57. package/dist/definitions/ssr-next/search/controllers/quickview/headless-quickview.ssr.d.ts +1 -1
  58. package/dist/definitions/ssr-next/search/controllers/recent-queries-list/headless-recent-queries-list.ssr.d.ts +1 -1
  59. package/dist/definitions/ssr-next/search/controllers/recent-results-list/headless-recent-results-list.ssr.d.ts +1 -1
  60. package/dist/definitions/ssr-next/search/controllers/relevance-inspector/headless-relevance-inspector.ssr.d.ts +1 -1
  61. package/dist/definitions/ssr-next/search/controllers/result-list/headless-result-list.ssr.d.ts +1 -1
  62. package/dist/definitions/ssr-next/search/controllers/results-per-page/headless-results-per-page.ssr.d.ts +1 -1
  63. package/dist/definitions/ssr-next/search/controllers/search-box/headless-search-box.ssr.d.ts +1 -1
  64. package/dist/definitions/ssr-next/search/controllers/search-parameter-manager/headless-search-parameter-manager.ssr.d.ts +1 -1
  65. package/dist/definitions/ssr-next/search/controllers/search-status/headless-search-status.ssr.d.ts +1 -1
  66. package/dist/definitions/ssr-next/search/controllers/smart-snippet/headless-smart-snippet.ssr.d.ts +1 -1
  67. package/dist/definitions/ssr-next/search/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.ssr.d.ts +1 -1
  68. package/dist/definitions/ssr-next/search/controllers/sort/headless-sort.ssr.d.ts +1 -1
  69. package/dist/definitions/ssr-next/search/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts +1 -1
  70. package/dist/definitions/ssr-next/search/controllers/static-filter/headless-static-filter.ssr.d.ts +1 -1
  71. package/dist/definitions/ssr-next/search/controllers/tab/headless-tab.ssr.d.ts +1 -1
  72. package/dist/definitions/ssr-next/search/controllers/tab-manager/headless-tab-manager.ssr.d.ts +1 -1
  73. package/dist/definitions/ssr-next/search/controllers/triggers/headless-execute-trigger.ssr.d.ts +1 -1
  74. package/dist/definitions/ssr-next/search/controllers/triggers/headless-notify-trigger.ssr.d.ts +1 -1
  75. package/dist/definitions/ssr-next/search/controllers/triggers/headless-query-trigger.ssr.d.ts +1 -1
  76. package/dist/definitions/ssr-next/search/controllers/triggers/headless-redirection-trigger.ssr.d.ts +1 -1
  77. package/dist/definitions/ssr-next/search/controllers/url-manager/headless-url-manager.ssr.d.ts +1 -1
  78. package/dist/definitions/ssr-next/search/engine/search-engine.ssr.d.ts +6 -13
  79. package/dist/definitions/ssr-next/search/types/build.d.ts +12 -0
  80. package/dist/definitions/ssr-next/search/types/controller-definition.d.ts +28 -0
  81. package/dist/definitions/ssr-next/{common/types/inference.d.ts → search/types/controller-inference.d.ts} +3 -6
  82. package/dist/definitions/ssr-next/search/types/engine.d.ts +52 -0
  83. package/dist/definitions/ssr-next/{common → search}/types/fetch-static-state.d.ts +5 -4
  84. package/dist/definitions/ssr-next/{common → search}/types/hydrate-static-state.d.ts +6 -7
  85. package/dist/definitions/ssr-next.index.d.ts +6 -4
  86. package/dist/definitions/test/mock-ssr-controller-definitions.d.ts +13 -1
  87. package/dist/esm/ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js +1 -1
  88. package/dist/esm/ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js +1 -1
  89. package/dist/esm/ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js +1 -1
  90. package/dist/esm/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js +1 -1
  91. package/dist/esm/ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.js +1 -1
  92. package/dist/esm/ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js +1 -1
  93. package/dist/esm/ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js +1 -1
  94. package/dist/esm/ssr-next/commerce/factories/build-factory.js +4 -9
  95. package/dist/esm/ssr-next/commerce/factories/hydrated-state-factory.js +1 -1
  96. package/dist/esm/ssr-next/commerce/factories/recommendation-hydrated-state-factory.js +1 -1
  97. package/dist/esm/ssr-next/commerce/factories/recommendation-static-state-factory.js +2 -11
  98. package/dist/esm/ssr-next/commerce/factories/static-state-factory.js +1 -1
  99. package/dist/esm/ssr-next/commerce/utils/controller-wiring.js +32 -15
  100. package/dist/esm/ssr-next/commerce/utils/recommendation-filter.js +27 -8
  101. package/dist/esm/ssr-next/{common → search}/controller-utils.js +4 -4
  102. package/dist/esm/ssr-next/search/engine/search-engine.ssr.js +5 -3
  103. package/dist/esm/ssr-next/search/types/engine.js +1 -0
  104. package/dist/esm/ssr-next/search/types/fetch-static-state.js +1 -0
  105. package/dist/esm/ssr-next/search/types/hydrate-static-state.js +1 -0
  106. package/dist/esm/test/mock-ssr-controller-definitions.js +15 -0
  107. package/dist/esm/utils/version.js +1 -1
  108. package/dist/quantic/case-assist/headless.js +1 -1
  109. package/dist/quantic/commerce/headless.js +1 -1
  110. package/dist/quantic/headless.js +1 -1
  111. package/dist/quantic/insight/headless.js +1 -1
  112. package/dist/quantic/recommendation/headless.js +1 -1
  113. package/package.json +1 -1
  114. package/dist/definitions/ssr-next/common/types/build.d.ts +0 -12
  115. /package/dist/esm/ssr-next/common/types/{build.js → controller-inference.js} +0 -0
  116. /package/dist/esm/ssr-next/{common/types/fetch-static-state.js → search/types/build.js} +0 -0
  117. /package/dist/esm/ssr-next/{common/types/hydrate-static-state.js → search/types/controller-definition.js} +0 -0
  118. /package/dist/esm/ssr-next/{common/types/inference.js → search/types/controller-inference.js} +0 -0
@@ -1306,7 +1306,7 @@ var import_toolkit2 = require("@reduxjs/toolkit");
1306
1306
  var import_toolkit = require("@reduxjs/toolkit");
1307
1307
 
1308
1308
  // src/utils/version.ts
1309
- var VERSION = "3.29.2-pre.8dc80e7b9d";
1309
+ var VERSION = "3.29.2-pre.94d7ba76cf";
1310
1310
  var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
1311
1311
 
1312
1312
  // src/api/analytics/analytics-selectors.ts
@@ -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> {
@@ -117,12 +117,12 @@ export { defineQueryTrigger } from './ssr-next/commerce/controllers/triggers/hea
117
117
  export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTriggerState, } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
118
118
  export { defineRedirectionTrigger } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
119
119
  export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
120
- export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './ssr-next/commerce/factories/build-factory.js';
120
+ export type { SSRCommerceEngine as CommerceEngine } from './ssr-next/commerce/factories/build-factory.js';
121
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, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
123
+ export type { CommerceEngineDefinitionControllersPropsOption as EngineDefinitionControllersPropsOption, ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, 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, CommerceEngineDefinitionBuildResult, EngineStaticState, FetchStaticState, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
125
+ export type { CommerceEngineDefinition, CommerceEngineDefinitionBuildResult, CommerceEngineDefinitionOptions, 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';
@@ -121,7 +121,7 @@ export type { CommerceEngineDefinition } from './ssr/commerce/engine/commerce-en
121
121
  export { defineCommerceEngine } from './ssr/commerce/engine/commerce-engine.ssr.js';
122
122
  export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './ssr/commerce/factories/build-factory.js';
123
123
  export { SolutionType } from './ssr/commerce/types/controller-constants.js';
124
- export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr/commerce/types/controller-definitions.js';
124
+ export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr/commerce/types/controller-definitions.js';
125
125
  export type { InferBuildResult, InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr/commerce/types/controller-inference.js';
126
126
  export type { Build, BuildOptions, EngineDefinition, EngineStaticState, FetchStaticState, FetchStaticStateOptions, FromBuildResult, FromBuildResultOptions, HydrateStaticState, HydrateStaticStateOptions, } from './ssr/commerce/types/engine.js';
127
127
  export { Kind } from './ssr/commerce/types/kind.js';
@@ -1,10 +1,10 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
2
  import type { Controller } from '../../controllers/controller/headless-controller.js';
3
+ import type { EngineStaticState } from '../common/types/engine.js';
3
4
  import type { SSRCommerceEngine } from './factories/build-factory.js';
4
5
  import type { SolutionType } from './types/controller-constants.js';
5
6
  import type { ControllerDefinitionOption, ControllerDefinitionsMap } from './types/controller-definitions.js';
6
7
  import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './types/controller-inference.js';
7
- import type { EngineStaticState } from './types/engine.js';
8
8
  export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<Controller>>({ searchActions, controllers, }: {
9
9
  searchActions: TSearchAction[];
10
10
  controllers: InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>;
@@ -1,11 +1,13 @@
1
- import { type Recommendations, type RecommendationsOptions, type RecommendationsProps, type RecommendationsState } from '../../../../controllers/commerce/recommendations/headless-recommendations.js';
1
+ import { type Recommendations, type RecommendationsOptions, type RecommendationsState } from '../../../../controllers/commerce/recommendations/headless-recommendations.js';
2
2
  import { recommendationInternalOptionKey } from '../../types/controller-constants.js';
3
3
  import type { RecommendationOnlyControllerDefinitionWithProps } from '../../types/controller-definitions.js';
4
4
  export type { Recommendations, RecommendationsState };
5
5
  export type RecommendationsDefinitionMeta = {
6
- [recommendationInternalOptionKey]: {} & RecommendationsProps['options'];
6
+ [recommendationInternalOptionKey]: {} & RecommendationsOptions;
7
7
  };
8
- export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, Partial<RecommendationsOptions>> {
8
+ export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, {
9
+ initialState: Partial<RecommendationsOptions>;
10
+ }> {
9
11
  }
10
12
  /**
11
13
  * Defines a `Recommendations` controller instance.
@@ -14,4 +16,6 @@ export interface RecommendationsDefinition extends RecommendationOnlyControllerD
14
16
  * @param props - The configurable `Recommendations` properties.
15
17
  * @returns The `Recommendations` controller definition.
16
18
  * */
17
- export declare function defineRecommendations(props: RecommendationsProps): RecommendationsDefinition & RecommendationsDefinitionMeta;
19
+ export declare function defineRecommendations(props: {
20
+ options: Omit<RecommendationsOptions, 'productId'>;
21
+ }): RecommendationsDefinition & RecommendationsDefinitionMeta;
@@ -2,10 +2,9 @@
2
2
  * Utility functions to be used for Commerce Server Side Rendering.
3
3
  */
4
4
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
5
- import type { CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
6
5
  import { SolutionType } from '../types/controller-constants.js';
7
6
  import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
8
- import type { CommerceEngineDefinition } from '../types/engine.js';
7
+ import type { CommerceEngineDefinition, CommerceEngineDefinitionOptions } from '../types/engine.js';
9
8
  /**
10
9
  * Initializes a Commerce engine definition in SSR with given controllers definitions and commerce engine config.
11
10
  * @param options - The commerce engine definition
@@ -1,10 +1,7 @@
1
1
  import type { Action } from '@reduxjs/toolkit';
2
2
  import { type CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
3
- import type { Controller } from '../../../controllers/controller/headless-controller.js';
4
- import type { SSRCommerceEngineOptions } from '../types/build.js';
5
3
  import { SolutionType } from '../types/controller-constants.js';
6
- import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
7
- import type { BuildParameters, CommerceControllerDefinitionsMap, EngineDefinitionOptions } from '../types/engine.js';
4
+ import type { BuildParameters, CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions } from '../types/engine.js';
8
5
  /**
9
6
  * The SSR commerce engine.
10
7
  *
@@ -16,7 +13,6 @@ export interface SSRCommerceEngine extends CommerceEngine {
16
13
  */
17
14
  waitForRequestCompletedAction(): Promise<Action>[];
18
15
  }
19
- export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<SSRCommerceEngineOptions, TControllers>;
20
16
  export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
21
17
  engine: SSRCommerceEngine;
22
18
  controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, T>;
@@ -1,5 +1,4 @@
1
1
  import type { SolutionType } from '../types/controller-constants.js';
2
2
  import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
3
- import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
4
- import { type CommerceEngineDefinitionOptions } from './build-factory.js';
3
+ import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, HydrateStaticStateFunction } from '../types/engine.js';
5
4
  export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;
@@ -1,3 +1,2 @@
1
- import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
2
- import { type CommerceEngineDefinitionOptions } from './build-factory.js';
1
+ import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, HydrateStaticStateFunction } from '../types/engine.js';
3
2
  export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions>;
@@ -1,4 +1,3 @@
1
1
  import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
2
- import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
3
- import { type CommerceEngineDefinitionOptions } from './build-factory.js';
2
+ import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateFunction } from '../types/engine.js';
4
3
  export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): FetchStaticStateFunction<TControllerDefinitions>;
@@ -1,5 +1,4 @@
1
1
  import { SolutionType } from '../types/controller-constants.js';
2
2
  import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
3
- import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
4
- import { type CommerceEngineDefinitionOptions } from './build-factory.js';
3
+ import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateFunction } from '../types/engine.js';
5
4
  export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;
@@ -1,21 +1,18 @@
1
1
  import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
2
2
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
3
3
  import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
4
- import type { OptionsTuple } from '../../common/types/utilities.js';
4
+ import type { HasKey, OptionsTuple } from '../../common/types/utilities.js';
5
5
  import type { CartInitialState } from '../controllers/cart/headless-cart.ssr.js';
6
6
  import type { ContextOptions } from '../controllers/context/headless-context.ssr.js';
7
7
  import type { ParameterManagerState, Parameters } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
8
8
  import type { SolutionType } from './controller-constants.js';
9
- import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
9
+ import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, IsRecommendationController } from './controller-definitions.js';
10
10
  import type { CommerceEngineDefinitionBuildResult } from './engine.js';
11
11
  export interface SearchBuildConfig extends CommonBuildConfig {
12
12
  searchParams: ParameterManagerState<Parameters & {
13
13
  query: string;
14
14
  }>['parameters'];
15
15
  }
16
- export interface RecommendationBuildConfig extends CommonBuildConfig {
17
- recommendations?: [];
18
- }
19
16
  export interface ListingBuildConfig extends CommonBuildConfig {
20
17
  }
21
18
  export interface StandaloneBuildConfig extends CommonBuildConfig {
@@ -25,14 +22,68 @@ export interface CommonBuildConfig {
25
22
  searchParams?: ParameterManagerState<Parameters>['parameters'];
26
23
  cart?: CartInitialState;
27
24
  }
28
- 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;
29
25
  /**
30
26
  * Commerce engine options for SSR scenarios where context is defined when fetching static state.
31
27
  */
32
28
  export type SSRCommerceEngineOptions = Omit<CommerceEngineOptions, 'configuration'> & {
33
29
  configuration: Omit<CommerceEngineOptions['configuration'], 'context'>;
34
30
  };
31
+ /**
32
+ * The `RecommendationBuildConfig` type defines the shape of the configuration object required when fetching static state for recommendations.
33
+ *
34
+ * The `recommendations` property is a string array containing the names of the recommendation controllers
35
+ * that were defined in your engine definition. This allows you to specify which recommendation controllers
36
+ * should be included in the SSR request.
37
+ *
38
+ * For example, on a storefront homepage, it might make sense to display a carousel of popular products.
39
+ * However, showing recommendations based on items frequently bought together may not be relevant in that context and should not be retrieved unnecessarily.
40
+ *
41
+ * @example
42
+ * Given the following engine definition:
43
+ *
44
+ * ```ts
45
+ * const {recommendationEngineDefinition} = defineCommerceEngine({
46
+ * controllers: {
47
+ * popularProducts: defineRecommendations({options: {slotId: '...'}}),
48
+ * frequentlyBought: defineRecommendations({options: {slotId: '...'}}),
49
+ * // ...other controllers
50
+ * },
51
+ * });
52
+ *
53
+ * // When fetching static state for recommendations:
54
+ * const staticState = await recommendationEngineDefinition.fetchStaticState({
55
+ * recommendations: ['popularProducts'],
56
+ * // ...other config
57
+ * });
58
+ * ```
59
+ *
60
+ * In this example, only the `popularProducts` recommendation controller will be included in the SSR request.
61
+ */
62
+ export type RecommendationBuildConfig<TControllers extends ControllerDefinitionsMap<Controller>> = CommonBuildConfig & {
63
+ /**
64
+ * The unique identifier of the product to use for seeded recommendations.
65
+ */
66
+ productId?: string;
67
+ /**
68
+ * An array of recommendation controller names from your engine definition to include in the SSR request.
69
+ * Each name corresponds to a key used when defining recommendation controllers in your engine definition.
70
+ * If not specified, no recommendation requests will be executed.
71
+ */
72
+ recommendations: Array<Extract<keyof TControllers, {
73
+ [K in keyof TControllers]: HasKey<TControllers[K], SolutionType.recommendation> extends never ? never : IsRecommendationController<TControllers[K]> extends never ? never : K;
74
+ }[keyof TControllers]>>;
75
+ };
76
+ export interface ListingBuildConfig extends CommonBuildConfig {
77
+ }
78
+ export interface StandaloneBuildConfig extends CommonBuildConfig {
79
+ }
80
+ export interface CommonBuildConfig {
81
+ context: ContextOptions;
82
+ searchParams?: ParameterManagerState<Parameters>['parameters'];
83
+ cart?: CartInitialState;
84
+ }
85
+ export type BuildConfig<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.search ? SearchBuildConfig : TSolutionType extends SolutionType.listing ? ListingBuildConfig : TSolutionType extends SolutionType.recommendation ? RecommendationBuildConfig<TControllers> : TSolutionType extends SolutionType.standalone ? CommonBuildConfig : never;
35
86
  /**
36
87
  * @internal
37
88
  */
38
- 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>>;
89
+ export type Build<TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TControllersDefinitionsMap, TSolutionType> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<CommerceEngineDefinitionBuildResult<TControllersMap>>;
@@ -1,27 +1,18 @@
1
1
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
2
2
  import type { InvalidControllerDefinition } from '../../common/errors.js';
3
+ import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/controller-inference.js';
3
4
  import type { ControllersPropsMap } from '../../common/types/controllers.js';
4
- import type { HydratedState } from '../../common/types/hydrate-static-state.js';
5
- import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/inference.js';
6
- import type { HasKey, HasOptionalKeys, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
5
+ import type { HasKey, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
7
6
  import type { CartDefinition } from '../controllers/cart/headless-cart.ssr.js';
8
7
  import type { ContextDefinition } from '../controllers/context/headless-context.ssr.js';
9
8
  import type { ParameterManagerDefinition } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
10
9
  import type { SSRCommerceEngine } from '../factories/build-factory.js';
11
10
  import { type recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
12
11
  import type { ListingAndStandaloneController, ListingOnlyController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
12
+ import type { HydratedState } from './hydrate-static-state.js';
13
13
  import type { Kind } from './kind.js';
14
14
  import type { HasSolutionType } from './utilities.js';
15
15
  export type { HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
16
- export type RecommendationControllerSettings = {
17
- /**
18
- * Toggle to enable or disable the recommendation controller.
19
- * When set to `true`, the controller will perform a recommendation request server-side.
20
- *
21
- * @default false
22
- */
23
- enabled?: boolean;
24
- };
25
16
  export interface ControllerDefinitionWithoutProps<TController extends Controller> {
26
17
  /**
27
18
  * Creates an instance of the given controller.
@@ -92,122 +83,16 @@ export type FilteredBakedInControllers<TSolutionType extends SolutionType> = {
92
83
  */
93
84
  export type AugmentedControllerDefinition<TControllerDefinitions extends ControllerDefinitionsMap<Controller>> = TControllerDefinitions & BakedInControllerDefinitions;
94
85
  /**
95
- * This type defines the required and optional controller props for the engine definition.
96
- */
97
- export type EngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = OptionalEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType> & RequiredEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType>;
98
- /**
99
- * Represents an optional engine definition for controller properties.
100
- *
101
- * This type is used to define a map of optional controller properties based on the provided
102
- * controller definitions, controller properties map, and solution type.
103
- *
104
- * @template TControllers - A map of controller definitions.
105
- * @template TControllersPropsMap - A map of controller properties.
106
- * @template TSolutionType - The type of solution.
107
- *
108
- * The type iterates over the controller keys (defined in the engine definition) and includes only those keys where:
109
- * 1. The controller can be used for a specific solution type (HasKey<TControllers[K], TSolutionType> is not 'never').
110
- * 2. The controller properties have optional options (HasOptionalKeys<ConditionalControllerProps<...>> is true).
111
- *
112
- * @example
113
- * Given the following controller definitions:
114
- * ```
115
- * const {recommendationEngineDefinition} = defineCommerceEngine({
116
- * controllers: {
117
- * popularViewed: defineRecommendations({
118
- * options: {slotId: 'slot-id'}
119
- * })
120
- * }
121
- * });
122
- * ```
123
- *
124
- * The following code will not throw an error since the 'popularViewed' controller props are optional
125
- * ```
126
- * recommendationEngineDefinition.fetchStaticState({
127
- * controllers: {
128
- * popularViewed: {enabled: true, productId: 'some-product-id'} // This is optional
129
- * }
130
- * })
131
- * ```
132
- *
133
- * The following code (with no arguments) is also valid because the 'popularViewed' controller props are optional, and there are no other required controller props in the engine definition.
134
- * ```
135
- * recommendationEngineDefinition.fetchStaticState()
136
- * ```
137
- */
138
- type OptionalEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
139
- [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : HasOptionalKeys<ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>> extends false ? never : 'controllers']?: ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>;
140
- };
141
- /**
142
- * Represents a type that defines the required controller properties for engine definition controllers.
143
- *
144
- * @template TControllers - A map of controller definitions.
145
- * @template TControllersPropsMap - A map of controller properties.
146
- * @template TSolutionType - The type of solution being used.
147
- *
148
- * The type iterates over the controller keys (defined in the engine definition) and includes only those keys where:
149
- * 1. The controller can be used for a specific solution type (HasKey<TControllers[K], TSolutionType> is not 'never').
150
- * 2. The controller properties have required options (HasRequiredKeys<ConditionalControllerProps<...>> is true).
151
- *
152
- * The resulting type maps the valid keys to their corresponding conditional controller properties.
153
- *
154
- * @example
155
- * Given the following controller definitions:
156
- * ```
157
- * const {standaloneEngineDefinition} = defineCommerceEngine({
158
- * controllers: {cart: defineCart()},
159
- * });
160
- * ```
161
- *
162
- * The following code will not throw an error since the 'cart' controller props are required for the standalone engine definition:
163
- * ```
164
- * standaloneEngineDefinition.fetchStaticState({
165
- * controllers: {
166
- * cart: {initialState: {items: []}},
167
- * },
168
- * })
169
- * ```
170
- *
86
+ * This type defines the required and optional controller props for the commerce engine definition.
171
87
  */
88
+ export type CommerceEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = RequiredEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType>;
172
89
  type RequiredEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
173
- [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : HasRequiredKeys<ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>> extends false ? never : 'controllers']: ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>;
174
- };
175
- type IsRecommendationController<TController extends ControllerDefinition<Controller>> = HasKey<TController, typeof recommendationInternalOptionKey>;
176
- /**
177
- * This type ensures that recommendation controller props are optional, while other controller props remain required.
178
- *
179
- * It works by checking if the controller definition includes the `recommendationInternalOptionKey`.
180
- *
181
- * - If the key is present, the controller props are made optional.
182
- * - If the key is absent, the controller props are required.
183
- *
184
- * Example:
185
- *
186
- * ```typescript
187
- * type ControllerProps = InferControllerPropsFromDefinition<{
188
- * recommendation: defineRecommendation({}),
189
- * cart: defineCart(),
190
- * }>;
191
- *
192
- * // In this example:
193
- * // - The `recommendation` controller props are optional.
194
- * // - The `cart` controller props are required.
195
- *
196
- * const props: ControllerProps = {
197
- * cart: {initialState: {items: []}},
198
- * // recommendation props can be omitted
199
- * };
200
- * ```
201
- */
202
- type RecommendationControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
203
- [I in keyof TControllersPropsMap as I extends K ? IsRecommendationController<TControllers[I]> extends never ? never : I : never]?: TControllersPropsMap[I];
204
- } & {
205
- [I in keyof TControllersPropsMap as I extends K ? IsRecommendationController<TControllers[I]> extends never ? I : never : never]: TControllersPropsMap[I];
90
+ [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : IsRecommendationController<TControllers[K]> extends never ? HasRequiredKeys<DefaultControllerProps<TControllers, TControllersPropsMap, K>> extends false ? never : 'controllers' : never]: DefaultControllerProps<TControllers, TControllersPropsMap, K>;
206
91
  };
92
+ export type IsRecommendationController<TController extends ControllerDefinition<Controller>> = HasKey<TController, typeof recommendationInternalOptionKey>;
207
93
  type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
208
94
  [I in keyof TControllersPropsMap as I extends K ? I : never]: TControllersPropsMap[I];
209
95
  };
210
- 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>;
211
96
  export interface ControllerDefinitionOption {
212
97
  /**
213
98
  * Whether the controller will be used in a product listing context.
@@ -1,14 +1,10 @@
1
1
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
2
+ import type { InferHydratedState, InferStaticState } from '../../common/types/engine.js';
2
3
  import type { HasKey, HasKeys } from '../../common/types/utilities.js';
3
- import type { recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
4
- import type { ControllerDefinition, ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, InferControllerStaticStateFromController, RecommendationControllerSettings } from './controller-definitions.js';
5
- export type InferStaticState<T extends {
6
- fetchStaticState(...args: unknown[]): Promise<unknown>;
7
- }> = Awaited<ReturnType<T['fetchStaticState']>>;
8
- export type InferHydratedState<T extends {
9
- hydrateStaticState(...args: unknown[]): Promise<unknown>;
10
- }> = Awaited<ReturnType<T['hydrateStaticState']>>;
11
- type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? Props : Props & RecommendationControllerSettings : TController extends ControllerDefinitionWithoutProps<Controller> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? {} : RecommendationControllerSettings : unknown;
4
+ import type { SolutionType } from './controller-constants.js';
5
+ import type { ControllerDefinition, ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, InferControllerStaticStateFromController } from './controller-definitions.js';
6
+ export type { InferStaticState, InferHydratedState };
7
+ type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? Props : TController extends ControllerDefinitionWithoutProps<Controller> ? {} : unknown;
12
8
  export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<Controller>> = {
13
9
  [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;
14
10
  };
@@ -19,4 +15,3 @@ export type InferControllersMapFromDefinition<TControllers extends ControllerDef
19
15
  export type InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
20
16
  [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : K]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>> & InferControllerPropsFromDefinition<TControllers[K]>;
21
17
  };
22
- export {};
@@ -1,27 +1,26 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
- import type { EngineConfiguration } from '../../../app/engine-configuration.js';
3
2
  import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
4
3
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
5
- 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';
6
6
  import type { SSRCommerceEngine } from '../factories/build-factory.js';
7
- import type { Build } from './build.js';
7
+ import type { Build, SSRCommerceEngineOptions } from './build.js';
8
8
  import type { SolutionType } from './controller-constants.js';
9
9
  import type { BakedInControllers, ControllerDefinitionsMap } from './controller-definitions.js';
10
10
  import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './controller-inference.js';
11
11
  import type { FetchStaticState } from './fetch-static-state.js';
12
12
  import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
13
- export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState };
14
- export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
15
- searchActions: TSearchAction[];
16
- controllers: TControllers;
17
- }
13
+ export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, EngineStaticState, };
18
14
  type ReservedControllerNames = 'context' | 'parameterManager' | 'cart';
19
15
  type ValidateControllerNames<T extends ControllerDefinitionsMap<Controller>> = {
20
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];
21
17
  };
22
- export type EngineDefinitionOptions<TOptions extends {
23
- configuration: EngineConfiguration;
24
- }, TControllers extends ControllerDefinitionsMap<Controller>> = TOptions & {
18
+ /**
19
+ * The options to create a Commerce engine definition in SSR.
20
+ *
21
+ * @group Engine
22
+ */
23
+ export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = SSRCommerceEngineOptions & {
25
24
  /**
26
25
  * The controllers to initialize with the commerce engine.
27
26
  */
@@ -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 { EngineStaticState } from '../../common/types/engine.js';
4
5
  import type { BuildConfig } from './build.js';
5
6
  import type { SolutionType } from './controller-constants.js';
6
- import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, FilteredBakedInControllers, OptionsTuple } from './controller-definitions.js';
7
- import type { EngineStaticState } from './engine.js';
7
+ import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, FilteredBakedInControllers, OptionsTuple } from './controller-definitions.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
  *
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<BuildConfig<TSolutionType> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState & FilteredBakedInControllers<TSolutionType>> & BuildConfig<TSolutionType>>;
13
+ export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TControllersDefinitionsMap, TSolutionType> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState & FilteredBakedInControllers<TSolutionType>> & BuildConfig<TControllersDefinitionsMap, TSolutionType>>;
@@ -1,11 +1,11 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
2
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
3
3
  import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
4
- import type { HydratedState } from '../../common/types/hydrate-static-state.js';
5
- import type { SSRCommerceEngine } from '../factories/build-factory.js';
6
4
  import type { BuildConfig } from './build.js';
7
5
  import type { SolutionType } from './controller-constants.js';
8
- import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
6
+ import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, OptionsTuple } from './controller-definitions.js';
7
+ import type { CommerceEngineDefinitionBuildResult } from './engine.js';
8
+ export type HydratedState<TControllers extends ControllersMap> = CommerceEngineDefinitionBuildResult<TControllers>;
9
9
  export interface HydrateStaticStateOptions<TSearchAction> {
10
10
  searchActions: TSearchAction[];
11
11
  }
@@ -14,4 +14,4 @@ export interface HydrateStaticStateOptions<TSearchAction> {
14
14
  *
15
15
  * Useful when hydrating a server-side-rendered engine.
16
16
  */
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>>;
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<TControllersDefinitionsMap, TSolutionType> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<HydratedState<TControllers>>;
@@ -1,8 +1,3 @@
1
- /**
2
- * Controller Wiring Utilities
3
- *
4
- * Transforms simple user configuration into complex internal controller structures.
5
- */
6
1
  import { Schema } from '@coveo/bueno';
7
2
  import type { ControllersPropsMap } from '../../common/types/controllers.js';
8
3
  import type { BuildConfig } from '../types/build.js';
@@ -20,7 +15,9 @@ export declare const searchDefinitionSchema: Schema<{
20
15
  export declare const standaloneDefinitionSchema: Schema<{
21
16
  context: unknown;
22
17
  }>;
23
- export declare const recommendationsDefinitionSchema: Schema<{
18
+ export declare const recommendationsDefinitionSchema: (recommendationName: string[]) => Schema<{
19
+ recommendations: import("@coveo/bueno").PrimitivesValues[] | null | undefined;
20
+ productId: string;
24
21
  context: unknown;
25
22
  }>;
26
23
  /**
@@ -33,6 +30,6 @@ export declare const recommendationsDefinitionSchema: Schema<{
33
30
  * @param buildConfig - Simple configuration object with simplified controller properties
34
31
  * @returns Formatted and validated controller properties map defined for the controller in the definition
35
32
  */
36
- export declare function wireControllerParams<TControllerDefinitions extends CommerceControllerDefinitionsMap>(solutionType: SolutionType, controllerDefinitions: TControllerDefinitions, buildConfig: BuildConfig<SolutionType> & {
33
+ export declare function wireControllerParams<TControllerDefinitions extends CommerceControllerDefinitionsMap>(solutionType: SolutionType, controllerDefinitions: TControllerDefinitions, buildConfig: BuildConfig<TControllerDefinitions, SolutionType> & {
37
34
  controllers?: ControllersPropsMap;
38
35
  }): InferControllerPropsMapFromDefinitions<TControllerDefinitions>;
@@ -1,5 +1,4 @@
1
1
  import type { CommerceEngineConfiguration } from '../../../app/commerce-engine/commerce-engine.js';
2
- import type { CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
3
2
  import type { CommonBuildConfig } from '../types/build.js';
4
- import type { CommerceControllerDefinitionsMap } from '../types/engine.js';
3
+ import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions } from '../types/engine.js';
5
4
  export declare function extendEngineConfiguration<TControllerDefinitions extends CommerceControllerDefinitionsMap>(configuration: CommerceEngineDefinitionOptions<TControllerDefinitions>['configuration'], commonBuildOptions: CommonBuildConfig): CommerceEngineConfiguration;
@@ -1,5 +1,18 @@
1
1
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
2
- import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
2
+ import type { RecommendationsDefinitionMeta } from '../controllers/recommendations/headless-recommendations.ssr.js';
3
+ import type { ControllerDefinition, ControllerDefinitionsMap } from '../types/controller-definitions.js';
4
+ /**
5
+ * Type guard to check if a controller definition is a recommendation controller.
6
+ * A recommendation controller must have both the recommendation flag and a slotId.
7
+ */
8
+ export declare function isRecommendationDefinition<C extends ControllerDefinition<Controller>>(controllerDefinition: C): controllerDefinition is C & RecommendationsDefinitionMeta;
9
+ /**
10
+ * Extracts recommendation controller definitions from a controller definitions map.
11
+ *
12
+ * @param controllerDefinitions - Map of controller definitions
13
+ * @returns Object containing only the recommendation controller definitions
14
+ */
15
+ export declare function getRecommendationDefinitions(controllerDefinitions: ControllerDefinitionsMap<Controller>): Record<string, ControllerDefinition<Controller> & RecommendationsDefinitionMeta>;
3
16
  export declare function filterRecommendationControllers<TControllerDefinitions extends ControllerDefinitionsMap<Controller>>(controllers: Record<string, Controller>, controllerDefinitions: TControllerDefinitions): {
4
17
  /**
5
18
  * Go through all the controllers passed in argument and only refresh recommendation controllers.
@@ -0,0 +1,6 @@
1
+ import type { Controller } from '../../../controllers/controller/headless-controller.js';
2
+ import type { ControllerStaticState, ControllersMap } from './controllers.js';
3
+ export type InferControllerStaticStateFromController<TController extends Controller> = ControllerStaticState<TController['state']>;
4
+ export type InferControllerStaticStateMapFromControllers<TControllers extends ControllersMap> = {
5
+ [K in keyof TControllers]: InferControllerStaticStateFromController<TControllers[K]>;
6
+ };