@coveo/quantic 3.10.0 → 3.11.0

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 (28) hide show
  1. package/README.md +52 -12
  2. package/force-app/main/default/labels/CustomLabels.labels-meta.xml +7 -0
  3. package/force-app/main/default/lwc/quanticNotifications/__tests__/quanticNotifications.test.js +112 -4
  4. package/force-app/main/default/lwc/quanticNotifications/quanticNotifications.css +8 -0
  5. package/force-app/main/default/lwc/quanticNotifications/quanticNotifications.html +20 -7
  6. package/force-app/main/default/lwc/quanticNotifications/quanticNotifications.js +57 -18
  7. package/force-app/main/default/lwc/quanticUserActionsToggle/__tests__/quanticUserActionsToggle.test.js +18 -0
  8. package/force-app/main/default/lwc/quanticUserActionsToggle/e2e/data.ts +32 -0
  9. package/force-app/main/default/lwc/quanticUserActionsToggle/e2e/fixture.ts +32 -0
  10. package/force-app/main/default/lwc/quanticUserActionsToggle/e2e/pageObject.ts +71 -0
  11. package/force-app/main/default/lwc/quanticUserActionsToggle/e2e/quanticUserActionsToggle.e2e.ts +39 -0
  12. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +6 -6
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/build.d.ts +4 -8
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/common.d.ts +166 -5
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/core-engine.d.ts +3 -3
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/fetch-static-state.d.ts +4 -12
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/from-build-result.d.ts +1 -1
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/hydrate-static-state.d.ts +4 -11
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/common.d.ts +6 -0
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/context/cart/headless-cart.ssr.d.ts +2 -2
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/context/headless-context.ssr.d.ts +2 -2
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.d.ts +1 -1
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recommendations/headless-recommendations.ssr.d.ts +4 -4
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/standalone-search-box/headless-standalone-search-box.ssr.d.ts +2 -2
  25. package/force-app/main/default/staticresources/coveoheadless/headless.js +8 -8
  26. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +7 -7
  27. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +6 -6
  28. package/package.json +11 -7
@@ -1,17 +1,13 @@
1
+ import { Controller } from '../../../controllers/controller/headless-controller.js';
1
2
  import type { ControllersMap, ControllersPropsMap, EngineDefinitionBuildResult, OptionsExtender, OptionsTuple } from '../../ssr-engine/types/common.js';
2
3
  import { SSRCommerceEngine } from '../factories/build-factory.js';
3
- import { EngineDefinitionControllersPropsOption, SolutionType } from './common.js';
4
+ import { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, SolutionType } from './common.js';
4
5
  export interface BuildOptions<TEngineOptions> {
5
6
  extend?: OptionsExtender<TEngineOptions>;
6
7
  }
7
- export type Build<TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.recommendation ? {
8
+ export type Build<TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
8
9
  /**
9
10
  * Initializes an engine and controllers from the definition.
10
11
  */
11
- (controllers: (keyof TControllersMap)[]): Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;
12
- } : {
13
- /**
14
- * Initializes an engine and controllers from the definition.
15
- */
16
- (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersProps>>): Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;
12
+ (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>): Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;
17
13
  };
@@ -1,15 +1,25 @@
1
1
  import { UnknownAction } from '@reduxjs/toolkit';
2
2
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
3
3
  import type { InvalidControllerDefinition } from '../../../utils/errors.js';
4
- import type { HasKey, InferControllerStaticStateMapFromControllers, InferControllerStaticStateFromController, InferControllerPropsMapFromDefinitions, ControllerStaticStateMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, OptionsTuple } from '../../ssr-engine/types/common.js';
4
+ import type { HasKey, InferControllerStaticStateMapFromControllers, InferControllerStaticStateFromController, ControllerStaticStateMap, EngineDefinitionBuildResult, HydratedState, OptionsTuple, ControllersPropsMap, HasKeys, HasRequiredKeys, HasOptionalKeys } from '../../ssr-engine/types/common.js';
5
5
  import { SSRCommerceEngine } from '../factories/build-factory.js';
6
- export type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferControllerPropsMapFromDefinitions, };
6
+ export type { EngineDefinitionBuildResult, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
7
7
  export declare enum SolutionType {
8
8
  search = "search",
9
9
  listing = "listing",
10
10
  standalone = "standalone",
11
11
  recommendation = "recommendation"
12
12
  }
13
+ export declare const recommendationInternalOptionKey: unique symbol;
14
+ export type RecommendationControllerSettings = {
15
+ /**
16
+ * Toggle to enable or disable the recommendation controller.
17
+ * When set to `true`, the controller will perform a recommendation request server-side.
18
+ *
19
+ * @default false
20
+ */
21
+ enabled?: boolean;
22
+ };
13
23
  export interface ControllerDefinitionWithoutProps<TController extends Controller> {
14
24
  /**
15
25
  * Creates an instance of the given controller.
@@ -39,7 +49,10 @@ export type ControllerDefinition<TController extends Controller> = ControllerDef
39
49
  export interface ControllerDefinitionsMap<TController extends Controller> {
40
50
  [customName: string]: ControllerDefinition<TController>;
41
51
  }
42
- export type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? Props : TController extends ControllerDefinitionWithoutProps<Controller> ? {} : unknown;
52
+ export 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;
53
+ export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<Controller>> = {
54
+ [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;
55
+ };
43
56
  export type InferControllerFromDefinition<TDefinition extends ControllerDefinition<Controller>> = TDefinition extends ControllerDefinition<infer TController> ? TController : never;
44
57
  export type InferControllersMapFromDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
45
58
  [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : K]: InferControllerFromDefinition<TControllers[K]>;
@@ -47,6 +60,123 @@ export type InferControllersMapFromDefinition<TControllers extends ControllerDef
47
60
  export type InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
48
61
  [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : K]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>>;
49
62
  };
63
+ /**
64
+ * This type defines the required and optional controller props for the engine definition.
65
+ */
66
+ export type EngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = OptionalEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType> & RequiredEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType>;
67
+ /**
68
+ * Represents an optional engine definition for controller properties.
69
+ *
70
+ * This type is used to define a map of optional controller properties based on the provided
71
+ * controller definitions, controller properties map, and solution type.
72
+ *
73
+ * @template TControllers - A map of controller definitions.
74
+ * @template TControllersPropsMap - A map of controller properties.
75
+ * @template TSolutionType - The type of solution.
76
+ *
77
+ * The type iterates over the controller keys (defined in the engine definition) and includes only those keys where:
78
+ * 1. The controller can be used for a specific solution type (HasKey<TControllers[K], TSolutionType> is not 'never').
79
+ * 2. The controller properties have optional options (HasOptionalKeys<ConditionalControllerProps<...>> is true).
80
+ *
81
+ * @example
82
+ * Given the following controller definitions:
83
+ * ```
84
+ * const {recommendationEngineDefinition} = defineCommerceEngine({
85
+ * controllers: {
86
+ * popularViewed: defineRecommendations({
87
+ * options: {slotId: 'slot-id'}
88
+ * })
89
+ * }
90
+ * });
91
+ * ```
92
+ *
93
+ * The following code will not throw an error since the 'popularViewed' controller props are optional
94
+ * ```
95
+ * recommendationEngineDefinition.fetchStaticState({
96
+ * controllers: {
97
+ * popularViewed: {enabled: true, productId: 'some-product-id'} // This is optional
98
+ * }
99
+ * })
100
+ * ```
101
+ *
102
+ * 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.
103
+ * ```
104
+ * recommendationEngineDefinition.fetchStaticState()
105
+ * ```
106
+ */
107
+ export type OptionalEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
108
+ [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>;
109
+ };
110
+ /**
111
+ * Represents a type that defines the required controller properties for engine definition controllers.
112
+ *
113
+ * @template TControllers - A map of controller definitions.
114
+ * @template TControllersPropsMap - A map of controller properties.
115
+ * @template TSolutionType - The type of solution being used.
116
+ *
117
+ * The type iterates over the controller keys (defined in the engine definition) and includes only those keys where:
118
+ * 1. The controller can be used for a specific solution type (HasKey<TControllers[K], TSolutionType> is not 'never').
119
+ * 2. The controller properties have required options (HasRequiredKeys<ConditionalControllerProps<...>> is true).
120
+ *
121
+ * The resulting type maps the valid keys to their corresponding conditional controller properties.
122
+ *
123
+ * @example
124
+ * Given the following controller definitions:
125
+ * ```
126
+ * const {standaloneEngineDefinition} = defineCommerceEngine({
127
+ * controllers: {cart: defineCart()},
128
+ * });
129
+ * ```
130
+ *
131
+ * The following code will not throw an error since the 'cart' controller props are required for the standalone engine definition:
132
+ * ```
133
+ * standaloneEngineDefinition.fetchStaticState({
134
+ * controllers: {
135
+ * cart: {initialState: {items: []}},
136
+ * },
137
+ * })
138
+ * ```
139
+ *
140
+ */
141
+ export type RequiredEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
142
+ [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>;
143
+ };
144
+ type IsRecommendationController<TController extends ControllerDefinition<Controller>> = HasKey<TController, typeof recommendationInternalOptionKey>;
145
+ /**
146
+ * This type ensures that recommendation controller props are optional, while other controller props remain required.
147
+ *
148
+ * It works by checking if the controller definition includes the `recommendationInternalOptionKey`.
149
+ *
150
+ * - If the key is present, the controller props are made optional.
151
+ * - If the key is absent, the controller props are required.
152
+ *
153
+ * Example:
154
+ *
155
+ * ```typescript
156
+ * type ControllerProps = InferControllerPropsFromDefinition<{
157
+ * recommendation: defineRecommendation({}),
158
+ * cart: defineCart(),
159
+ * }>;
160
+ *
161
+ * // In this example:
162
+ * // - The `recommendation` controller props are optional.
163
+ * // - The `cart` controller props are required.
164
+ *
165
+ * const props: ControllerProps = {
166
+ * cart: {initialState: {items: []}},
167
+ * // recommendation props can be omitted
168
+ * };
169
+ * ```
170
+ */
171
+ type RecommendationControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
172
+ [I in keyof TControllersPropsMap as I extends K ? IsRecommendationController<TControllers[I]> extends never ? never : I : never]?: TControllersPropsMap[I];
173
+ } & {
174
+ [I in keyof TControllersPropsMap as I extends K ? IsRecommendationController<TControllers[I]> extends never ? I : never : never]: TControllersPropsMap[I];
175
+ };
176
+ type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
177
+ [I in keyof TControllersPropsMap as I extends K ? I : never]: TControllersPropsMap[I];
178
+ };
179
+ 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>;
50
180
  export interface ControllerDefinitionOption {
51
181
  /**
52
182
  * Whether the controller will be used in a product listing context.
@@ -59,6 +189,20 @@ export interface ControllerDefinitionOption {
59
189
  */
60
190
  search?: boolean;
61
191
  }
192
+ interface NonRecommendationController {
193
+ /**
194
+ * @internal
195
+ */
196
+ [SolutionType.search]: true;
197
+ /**
198
+ * @internal
199
+ */
200
+ [SolutionType.listing]: true;
201
+ /**
202
+ * @internal
203
+ */
204
+ [SolutionType.standalone]: true;
205
+ }
62
206
  interface UniversalController {
63
207
  /**
64
208
  * @internal
@@ -72,6 +216,10 @@ interface UniversalController {
72
216
  * @internal
73
217
  */
74
218
  [SolutionType.standalone]: true;
219
+ /**
220
+ * @internal
221
+ */
222
+ [SolutionType.recommendation]: true;
75
223
  }
76
224
  interface SearchOnlyController {
77
225
  /**
@@ -101,14 +249,27 @@ interface SearchAndListingController {
101
249
  */
102
250
  [SolutionType.listing]: true;
103
251
  }
252
+ interface ListingAndStandaloneController {
253
+ /**
254
+ * @internal
255
+ */
256
+ [SolutionType.listing]: true;
257
+ /**
258
+ * @internal
259
+ */
260
+ [SolutionType.standalone]: true;
261
+ }
104
262
  export type SearchOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchOnlyController;
105
263
  export type SearchOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchOnlyController;
264
+ export type ListingAndStandaloneControllerWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingAndStandaloneController;
106
265
  export type ListingOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingOnlyController;
107
266
  export type ListingOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & ListingOnlyController;
108
267
  export type RecommendationOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & RecommendationOnlyController;
109
268
  export type RecommendationOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & RecommendationOnlyController;
110
- export type NonRecommendationControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & UniversalController;
111
- export type NonRecommendationControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & UniversalController;
269
+ export type NonRecommendationControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & NonRecommendationController;
270
+ export type NonRecommendationControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & NonRecommendationController;
271
+ export type UniversalControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & UniversalController;
272
+ export type UniversalControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & UniversalController;
112
273
  export type SearchAndListingControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchAndListingController;
113
274
  export type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;
114
275
  export type SubControllerDefinitionWithoutProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined> = TDefinition extends {
@@ -23,15 +23,15 @@ export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<
23
23
  /**
24
24
  * Fetches the static state on the server side using your engine definition.
25
25
  */
26
- fetchStaticState: FetchStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TSolutionType>;
26
+ fetchStaticState: FetchStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
27
27
  /**
28
28
  * Fetches the hydrated state on the client side using your engine definition and the static state.
29
29
  */
30
- hydrateStaticState: HydrateStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerPropsMapFromDefinitions<TControllers>, TSolutionType>;
30
+ hydrateStaticState: HydrateStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
31
31
  /**
32
32
  * Builds an engine and its controllers from an engine definition.
33
33
  */
34
- build: Build<TEngineOptions, InferControllersMapFromDefinition<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TSolutionType>;
34
+ build: Build<TEngineOptions, InferControllersMapFromDefinition<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
35
35
  /**
36
36
  * Sets the navigator context provider.
37
37
  * This provider is essential for retrieving navigation-related data such as referrer, userAgent, location, and clientId, which are crucial for handling both server-side and client-side API requests effectively.
@@ -1,23 +1,15 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
- import { SolutionType } from '../../commerce-ssr-engine/types/common.js';
3
- import type { EngineDefinitionControllersPropsOption, EngineStaticState } from '../../commerce-ssr-engine/types/common.js';
2
+ import { Controller } from '../../../controllers/controller/headless-controller.js';
3
+ import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, EngineStaticState, SolutionType } from '../../commerce-ssr-engine/types/common.js';
4
4
  import type { ControllersMap, ControllersPropsMap, ControllerStaticStateMap, OptionsTuple } from '../../ssr-engine/types/common.js';
5
5
  import { FromBuildResult } from './from-build-result.js';
6
6
  export type FetchStaticStateOptions = {};
7
- export type FetchStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.recommendation ? {
7
+ export type FetchStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
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
- (controllers: Array<keyof TControllers>): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
14
- fromBuildResult: FromBuildResult<TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
15
- } : {
16
- /**
17
- * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
18
- *
19
- * Useful for static generation and server-side rendering.
20
- */
21
- (...params: OptionsTuple<FetchStaticStateOptions & EngineDefinitionControllersPropsOption<TControllersProps>>): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
13
+ (...params: OptionsTuple<FetchStaticStateOptions & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
22
14
  fromBuildResult: FromBuildResult<TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
23
15
  };
@@ -13,7 +13,7 @@ export interface FromBuildResultOptions<TControllers extends ControllersMap> {
13
13
  *
14
14
  * This is applicable only if the engine is a recommendation engine.
15
15
  */
16
- allowedRecommendationKeys?: (keyof TControllers)[];
16
+ allowedRecommendationKeys?: string[];
17
17
  }
18
18
  export interface FromBuildResult<TControllers extends ControllersMap, TOptions, TReturn> {
19
19
  (options: FromBuildResultOptions<TControllers> & TOptions): Promise<TReturn>;
@@ -1,25 +1,18 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
+ import { Controller } from '../../../controllers/controller/headless-controller.js';
2
3
  import type { ControllersMap, ControllersPropsMap, HydratedState, OptionsTuple } from '../../ssr-engine/types/common.js';
3
4
  import { SSRCommerceEngine } from '../factories/build-factory.js';
4
- import { EngineDefinitionControllersPropsOption, SolutionType } from './common.js';
5
+ import { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, SolutionType } from './common.js';
5
6
  import { FromBuildResult } from './from-build-result.js';
6
7
  export interface HydrateStaticStateOptions<TSearchAction> {
7
8
  searchActions: TSearchAction[];
8
9
  }
9
- export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.recommendation ? {
10
+ export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
10
11
  /**
11
12
  * Creates a new engine from the snapshot of the engine created in SSR with fetchStaticState.
12
13
  *
13
14
  * Useful when hydrating a server-side-rendered engine.
14
15
  */
15
- (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction>>): Promise<HydratedState<SSRCommerceEngine, TControllers>>;
16
- fromBuildResult: FromBuildResult<TControllers, HydrateStaticStateOptions<TSearchAction>, HydratedState<SSRCommerceEngine, TControllers>>;
17
- } : {
18
- /**
19
- * Creates a new engine from the snapshot of the engine created in SSR with fetchStaticState.
20
- *
21
- * Useful when hydrating a server-side-rendered engine.
22
- */
23
- (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & EngineDefinitionControllersPropsOption<TControllersProps>>): Promise<HydratedState<SSRCommerceEngine, TControllers>>;
16
+ (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>): Promise<HydratedState<SSRCommerceEngine, TControllers>>;
24
17
  fromBuildResult: FromBuildResult<TControllers, HydrateStaticStateOptions<TSearchAction>, HydratedState<SSRCommerceEngine, TControllers>>;
25
18
  };
@@ -3,6 +3,12 @@ import type { Controller } from '../../../controllers/controller/headless-contro
3
3
  import { CoreEngine, CoreEngineNext } from '../../engine.js';
4
4
  export type HasKey<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] extends never ? never : true : never : never;
5
5
  export type HasKeys<TObject> = TObject extends {} ? keyof TObject extends never ? false : true : boolean;
6
+ export type HasRequiredKeys<TObject> = TObject extends {} ? {
7
+ [K in keyof TObject]-?: {} extends Pick<TObject, K> ? never : K;
8
+ }[keyof TObject] extends never ? false : true : boolean;
9
+ export type HasOptionalKeys<TObject> = TObject extends {} ? {
10
+ [K in keyof TObject]-?: {} extends Pick<TObject, K> ? K : never;
11
+ }[keyof TObject] extends never ? false : true : boolean;
6
12
  export type ExtractRequiredOptions<TOptions> = {
7
13
  [TKey in keyof TOptions as Pick<TOptions, TKey> extends Required<Pick<TOptions, TKey>> ? TKey : never]: TOptions[TKey];
8
14
  };
@@ -1,11 +1,11 @@
1
- import { NonRecommendationControllerDefinitionWithProps } from '../../../../app/commerce-ssr-engine/types/common.js';
1
+ import { UniversalControllerDefinitionWithProps } from '../../../../app/commerce-ssr-engine/types/common.js';
2
2
  import { Cart, CartInitialState } from './headless-cart.js';
3
3
  export type { CartState, CartItem, CartProps } from './headless-cart.js';
4
4
  export type { Cart, CartInitialState };
5
5
  export interface CartBuildProps {
6
6
  initialState: CartInitialState;
7
7
  }
8
- export interface CartDefinition extends NonRecommendationControllerDefinitionWithProps<Cart, CartBuildProps> {
8
+ export interface CartDefinition extends UniversalControllerDefinitionWithProps<Cart, CartBuildProps> {
9
9
  }
10
10
  /**
11
11
  * Defines a `Cart` controller instance.
@@ -1,8 +1,8 @@
1
- import { NonRecommendationControllerDefinitionWithProps } from '../../../app/commerce-ssr-engine/types/common.js';
1
+ import { UniversalControllerDefinitionWithProps } from '../../../app/commerce-ssr-engine/types/common.js';
2
2
  import { Context, ContextOptions, View, UserLocation } from './headless-context.js';
3
3
  export type { ContextState, Context, ContextProps } from './headless-context.js';
4
4
  export type { View, UserLocation, ContextOptions };
5
- export interface ContextDefinition extends NonRecommendationControllerDefinitionWithProps<Context, ContextOptions> {
5
+ export interface ContextDefinition extends UniversalControllerDefinitionWithProps<Context, ContextOptions> {
6
6
  }
7
7
  /**
8
8
  * Defines a `Context` controller instance.
@@ -9,7 +9,7 @@ export interface ParameterManagerProps<T extends Parameters> {
9
9
  /**
10
10
  * The initial state that should be applied to the `ParameterManager` sub-controller.
11
11
  */
12
- initialState: ParameterManagerInitialState<T>;
12
+ initialState?: ParameterManagerInitialState<T>;
13
13
  }
14
14
  export interface CoreParameterManagerProps<T extends Parameters> extends ParameterManagerProps<T> {
15
15
  /**
@@ -1,14 +1,14 @@
1
- import { RecommendationOnlyControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
2
- import { RecommendationsState } from '../recommendations/headless-recommendations.js';
1
+ import { recommendationInternalOptionKey, RecommendationOnlyControllerDefinitionWithProps } from '../../../app/commerce-ssr-engine/types/common.js';
2
+ import { RecommendationsOptions, RecommendationsState } from '../recommendations/headless-recommendations.js';
3
3
  import { RecommendationsProps, Recommendations } from './headless-recommendations.js';
4
4
  export type { Recommendations, RecommendationsState };
5
5
  /**
6
6
  * @internal
7
7
  * */
8
8
  export type RecommendationsDefinitionMeta = {
9
- options: {} & RecommendationsProps['options'];
9
+ [recommendationInternalOptionKey]: {} & RecommendationsProps['options'];
10
10
  };
11
- export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithoutProps<Recommendations> {
11
+ export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, Partial<RecommendationsOptions>> {
12
12
  }
13
13
  /**
14
14
  * @internal
@@ -1,10 +1,10 @@
1
- import { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
1
+ import { ListingAndStandaloneControllerWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
2
2
  import { StandaloneSearchBoxProps } from '../../standalone-search-box/headless-standalone-search-box.js';
3
3
  import { StandaloneSearchBox } from './headless-standalone-search-box.js';
4
4
  export type { StandaloneSearchBoxOptions } from './headless-standalone-search-box-options.js';
5
5
  export type { StandaloneSearchBoxState } from './headless-standalone-search-box.js';
6
6
  export type { StandaloneSearchBox, StandaloneSearchBoxProps };
7
- export interface StandaloneSearchBoxDefinition extends NonRecommendationControllerDefinitionWithoutProps<StandaloneSearchBox> {
7
+ export interface StandaloneSearchBoxDefinition extends ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox> {
8
8
  }
9
9
  /**
10
10
  * Defines the `StandaloneSearchBox` controller for the purpose of server-side rendering.