@coveo/quantic 3.30.0-pre.7fbcdbbb29 → 3.30.0-pre.8a67bd16aa
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.
- package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/build.d.ts +5 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/controller-definitions.d.ts +3 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/kind.d.ts +3 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/build.d.ts +7 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts +9 -10
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controller-utils.d.ts +7 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/cart/headless-cart.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/context/headless-context.ssr.d.ts +2 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts +3 -13
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/product-list/headless-product-list.ssr.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/product-view/headless-product-view.ssr.d.ts +1 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.d.ts +4 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/search-box/headless-search-box.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/summary/headless-core-summary.ssr.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/build-factory.d.ts +5 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/hydrated-state-factory.d.ts +5 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-hydrated-state-factory.d.ts +3 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts +12 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts +7 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/build.d.ts +2 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/controller-definitions.d.ts +4 -53
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/controller-scopes.d.ts +0 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts +6 -12
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/utils/recommendation-filter.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/builders/static-controller-builder.d.ts +1 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/errors.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/types/utilities.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/types/build.d.ts +2 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/types/engine.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-ssr-controller-definitions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/headless.js +11 -11
- package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -9
- package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
- package/package.json +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/kind.d.ts +0 -9
|
@@ -5,14 +5,16 @@ import type { SSRCommerceEngine } from '../factories/build-factory.js';
|
|
|
5
5
|
import type { SolutionType } from './controller-constants.js';
|
|
6
6
|
import type { ControllerDefinitionsMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
|
|
7
7
|
/**
|
|
8
|
-
* @deprecated This type should not be used directly.
|
|
9
|
-
* @internal
|
|
8
|
+
* @deprecated This type should not be used directly. This interface will be removed in the next major release
|
|
10
9
|
*/
|
|
11
10
|
export interface BuildOptions<TEngineOptions> {
|
|
11
|
+
/**
|
|
12
|
+
* @deprecated This option will be removed in the next major version.
|
|
13
|
+
*/
|
|
12
14
|
extend?: OptionsExtender<TEngineOptions>;
|
|
13
15
|
}
|
|
14
16
|
/**
|
|
15
|
-
*
|
|
17
|
+
* This type should not be used directly.
|
|
16
18
|
* @internal
|
|
17
19
|
*/
|
|
18
20
|
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>>;
|
|
@@ -170,6 +170,9 @@ type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Contro
|
|
|
170
170
|
[I in keyof TControllersPropsMap as I extends K ? I : never]: TControllersPropsMap[I];
|
|
171
171
|
};
|
|
172
172
|
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>;
|
|
173
|
+
/**
|
|
174
|
+
* @deprecated This interface is no longer used and will be removed in next major version.
|
|
175
|
+
*/
|
|
173
176
|
export interface ControllerDefinitionOption {
|
|
174
177
|
/**
|
|
175
178
|
* Whether the controller will be used in a product listing context.
|
package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/build.d.ts
CHANGED
|
@@ -2,11 +2,18 @@ import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
|
|
|
2
2
|
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
|
+
/**
|
|
6
|
+
* @deprecated This type should not be used directly. This interface will be removed in the next major release
|
|
7
|
+
*/
|
|
5
8
|
interface BuildOptions<TEngineOptions> {
|
|
6
9
|
/**
|
|
7
10
|
* @deprecated This option will be removed in the next major version.
|
|
8
11
|
*/
|
|
9
12
|
extend?: OptionsExtender<TEngineOptions>;
|
|
10
13
|
}
|
|
14
|
+
/**
|
|
15
|
+
* This type should not be used directly.
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
11
18
|
export type Build<TEngine extends CoreEngine | CoreEngineNext, TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<EngineDefinitionBuildResult<TEngine, TControllersMap>>;
|
|
12
19
|
export {};
|
|
@@ -76,27 +76,27 @@ export type { LoggerOptions, LogLevel } from './app/logger.js';
|
|
|
76
76
|
export type { BrowserNavigatorContextProvider, NavigatorContext, NavigatorContextProvider, } from './app/navigator-context-provider.js';
|
|
77
77
|
export type { InteractiveProduct, InteractiveProductOptions, InteractiveProductProps, } from './controllers/commerce/core/interactive-product/headless-core-interactive-product.js';
|
|
78
78
|
export type { Controller, Subscribable, } from './controllers/controller/headless-controller.js';
|
|
79
|
-
export type { BreadcrumbManager, BreadcrumbManagerState, } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
|
|
79
|
+
export type { BreadcrumbManager, BreadcrumbManagerDefinition, BreadcrumbManagerState, } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
|
|
80
80
|
export { defineBreadcrumbManager } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
|
|
81
81
|
export type { Cart, CartBuildProps, CartDefinition, CartInitialState, CartItem, CartProps, CartState, } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
|
|
82
82
|
export { defineCart } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
|
|
83
83
|
export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, UserLocation, View, } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
|
|
84
84
|
export { defineContext } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
|
|
85
|
-
export type { DidYouMean, DidYouMeanState, } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
|
|
85
|
+
export type { DidYouMean, DidYouMeanDefinition, DidYouMeanState, } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
|
|
86
86
|
export { defineDidYouMean } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
|
|
87
87
|
export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, FieldSuggestionsFacet, FilterSuggestions, FilterSuggestionsGenerator, FilterSuggestionsGeneratorDefinition, FilterSuggestionsState, GeneratedFilterSuggestionsControllers, } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
|
|
88
88
|
export { defineFilterSuggestionsGenerator } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
|
|
89
|
-
export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetSearchResult, CategoryFacetState, CategoryFacetValue, CoreCommerceFacet, DateFacet, DateFacetState, DateFacetValue, FacetGenerator, FacetGeneratorState, FacetType, LocationFacet, LocationFacetState, LocationFacetValue, MappedFacetState, MappedFacetStates, MappedGeneratedFacetController, NumericFacet, NumericFacetState, NumericFacetValue, RegularFacet, RegularFacetState, RegularFacetValue, } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
|
|
89
|
+
export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetSearchResult, CategoryFacetState, CategoryFacetValue, CoreCommerceFacet, DateFacet, DateFacetState, DateFacetValue, FacetGenerator, FacetGeneratorDefinition, FacetGeneratorState, FacetType, LocationFacet, LocationFacetState, LocationFacetValue, MappedFacetState, MappedFacetStates, MappedGeneratedFacetController, NumericFacet, NumericFacetState, NumericFacetValue, RegularFacet, RegularFacetState, RegularFacetValue, } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
|
|
90
90
|
export { defineFacetGenerator } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
|
|
91
91
|
export type { InstantProducts, InstantProductsDefinition, InstantProductsOptions, InstantProductsProps, InstantProductsState, } from './ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.js';
|
|
92
92
|
export { defineInstantProducts } from './ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.js';
|
|
93
|
-
export type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState, } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
|
|
93
|
+
export type { CorePaginationOptions, Pagination, PaginationDefinition, PaginationOptions, PaginationProps, PaginationState, } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
|
|
94
94
|
export { definePagination } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
|
|
95
95
|
export type { CommerceSearchParameters, ParameterManager, ParameterManagerDefinition, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, SSRParameterManagerProps, } from './ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
|
|
96
96
|
export { defineParameterManager } from './ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
|
|
97
|
-
export type { ProductList, ProductListing, ProductListState, Search, } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
|
|
97
|
+
export type { ProductList, ProductListDefinition, ProductListing, ProductListState, Search, } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
|
|
98
98
|
export { defineProductList } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
|
|
99
|
-
export type { ProductView } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
|
|
99
|
+
export type { ProductView, ProductViewDefinition, } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
|
|
100
100
|
export { defineProductView } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
|
|
101
101
|
export type { RecentQueriesList, RecentQueriesListDefinition, RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesListProps, RecentQueriesState, } from './ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
|
|
102
102
|
export { defineRecentQueriesList } from './ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
|
|
@@ -104,11 +104,11 @@ export type { Recommendations, RecommendationsDefinition, RecommendationsState,
|
|
|
104
104
|
export { defineRecommendations } from './ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.js';
|
|
105
105
|
export type { CoreSearchBox, SearchBox, SearchBoxDefinition, SearchBoxOptions, SearchBoxProps, SearchBoxState, Suggestion, } from './ssr-next/commerce/controllers/search-box/headless-search-box.ssr.js';
|
|
106
106
|
export { defineSearchBox } from './ssr-next/commerce/controllers/search-box/headless-search-box.ssr.js';
|
|
107
|
-
export type { Sort, SortProps, SortState, } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
|
|
107
|
+
export type { Sort, SortDefinition, SortProps, SortState, } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
|
|
108
108
|
export { defineSort } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
|
|
109
109
|
export type { StandaloneSearchBox, StandaloneSearchBoxDefinition, StandaloneSearchBoxProps, StandaloneSearchBoxState, } from './ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
|
|
110
110
|
export { defineStandaloneSearchBox } from './ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
|
|
111
|
-
export type { ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, Summary, SummaryState, } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
|
|
111
|
+
export type { ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, Summary, SummaryDefinition, SummaryState, } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
|
|
112
112
|
export { defineSummary } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
|
|
113
113
|
export type { NotifyTrigger, NotifyTriggerDefinition, NotifyTriggerState, } from './ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.js';
|
|
114
114
|
export { defineNotifyTrigger } from './ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.js';
|
|
@@ -120,10 +120,9 @@ export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine
|
|
|
120
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 { CommerceEngineDefinitionControllersPropsOption as EngineDefinitionControllersPropsOption, ControllerDefinition, ControllerDefinitionsMap,
|
|
123
|
+
export type { CommerceEngineDefinitionControllersPropsOption as EngineDefinitionControllersPropsOption, ControllerDefinition, ControllerDefinitionsMap, 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
125
|
export type { CommerceEngineDefinition, CommerceEngineDefinitionBuildResult, CommerceEngineDefinitionOptions, EngineStaticState, FetchStaticState, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
|
|
126
|
-
export { Kind } from './ssr-next/commerce/types/kind.js';
|
|
127
126
|
export type { CommerceAppState, CommerceProductListingParametersState, CommerceSearchParametersState, } from './state/commerce-app-state.js';
|
|
128
127
|
export * from './features/commerce/configuration/configuration-actions-loader.js';
|
|
129
128
|
export * from './features/commerce/context/cart/cart-actions-loader.js';
|
|
@@ -2,17 +2,18 @@ import type { UnknownAction } from '@reduxjs/toolkit';
|
|
|
2
2
|
import type { Controller } from '../../controllers/controller/headless-controller.js';
|
|
3
3
|
import type { SSRCommerceEngine } from './factories/build-factory.js';
|
|
4
4
|
import type { SolutionType } from './types/controller-constants.js';
|
|
5
|
-
import type {
|
|
5
|
+
import type { ControllerDefinitionsMap, FilteredBakedInControllers } from './types/controller-definitions.js';
|
|
6
6
|
import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './types/controller-inference.js';
|
|
7
|
-
|
|
8
|
-
export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<Controller>>({ searchActions, controllers, }: {
|
|
7
|
+
export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>({ searchActions, controllers, }: {
|
|
9
8
|
searchActions: TSearchAction[];
|
|
10
|
-
controllers:
|
|
11
|
-
}):
|
|
9
|
+
controllers: Record<string, Controller>;
|
|
10
|
+
}): {
|
|
11
|
+
controllers: InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, TSolutionType> & FilteredBakedInControllers<TSolutionType>;
|
|
12
|
+
searchActions: TSearchAction[];
|
|
13
|
+
};
|
|
12
14
|
export declare function buildControllerDefinitions<TControllerDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>({ definitionsMap, engine, solutionType, propsMap, }: {
|
|
13
15
|
definitionsMap: TControllerDefinitionsMap;
|
|
14
16
|
engine: SSRCommerceEngine;
|
|
15
17
|
solutionType: TSolutionType;
|
|
16
18
|
propsMap?: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
|
|
17
19
|
}): InferControllersMapFromDefinition<TControllerDefinitionsMap, TSolutionType>;
|
|
18
|
-
export declare function ensureAtLeastOneSolutionType(options?: ControllerDefinitionOption): void;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type { BreadcrumbManager, BreadcrumbManagerState } from '../../../../controllers/commerce/core/breadcrumb-manager/headless-core-breadcrumb-manager.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { BreadcrumbManager, BreadcrumbManagerState };
|
|
4
|
+
export type BreadcrumbManagerDefinition = SearchAndListingControllerDefinitionWithoutProps<BreadcrumbManager>;
|
|
4
5
|
/**
|
|
5
6
|
* Defines a `BreadcrumbManager` controller instance.
|
|
6
7
|
* @group Definers
|
|
7
8
|
*
|
|
8
9
|
* @returns The `BreadcrumbManager` controller definition.
|
|
9
10
|
*/
|
|
10
|
-
export declare function defineBreadcrumbManager
|
|
11
|
+
export declare function defineBreadcrumbManager(): BreadcrumbManagerDefinition;
|
|
@@ -4,8 +4,7 @@ export type { Cart, CartInitialState, CartItem, CartProps, CartState };
|
|
|
4
4
|
export interface CartBuildProps {
|
|
5
5
|
initialState: CartInitialState;
|
|
6
6
|
}
|
|
7
|
-
export
|
|
8
|
-
}
|
|
7
|
+
export type CartDefinition = UniversalControllerDefinitionWithProps<Cart, CartBuildProps>;
|
|
9
8
|
/**
|
|
10
9
|
* Defines a `Cart` controller instance.
|
|
11
10
|
* @group Definers
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import { type Context, type ContextOptions, type ContextProps, type ContextState, type UserLocation, type View } from '../../../../controllers/commerce/context/headless-context.js';
|
|
2
2
|
import type { UniversalControllerDefinitionWithProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { Context, ContextProps, ContextState, View, UserLocation, ContextOptions, };
|
|
4
|
-
export
|
|
4
|
+
export type ContextDefinition = UniversalControllerDefinitionWithProps<Context, {
|
|
5
5
|
initialState: ContextOptions;
|
|
6
|
-
}
|
|
7
|
-
}
|
|
6
|
+
}>;
|
|
8
7
|
/**
|
|
9
8
|
* Defines a `Context` controller instance.
|
|
10
9
|
* @group Definers
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type { DidYouMean, DidYouMeanState } from '../../../../controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
|
|
2
2
|
import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { DidYouMean, DidYouMeanState };
|
|
4
|
+
export type DidYouMeanDefinition = SearchOnlyControllerDefinitionWithoutProps<DidYouMean>;
|
|
4
5
|
/**
|
|
5
6
|
* Defines a `DidYouMean` controller instance.
|
|
6
7
|
* @group Definers
|
|
7
8
|
*
|
|
8
9
|
* @returns The `DidYouMean` controller definition.
|
|
9
10
|
*/
|
|
10
|
-
export declare function defineDidYouMean():
|
|
11
|
+
export declare function defineDidYouMean(): DidYouMeanDefinition;
|
|
@@ -4,8 +4,7 @@ import type { FilterSuggestions, FilterSuggestionsState } from '../../../../cont
|
|
|
4
4
|
import { type FilterSuggestionsGenerator, type GeneratedFilterSuggestionsControllers } from '../../../../controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
|
|
5
5
|
import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
6
6
|
export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers, FieldSuggestionsFacet, CategoryFilterSuggestions, CategoryFilterSuggestionsState, FilterSuggestions, FilterSuggestionsState, };
|
|
7
|
-
export
|
|
8
|
-
}
|
|
7
|
+
export type FilterSuggestionsGeneratorDefinition = NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator>;
|
|
9
8
|
/**
|
|
10
9
|
* Defines the `FilterSuggestionsGenerator` controller for the purpose of server-side rendering.
|
|
11
10
|
* @group Definers
|
|
@@ -10,7 +10,7 @@ import type { NumericFacet, NumericFacetState, NumericFacetValue } from '../../.
|
|
|
10
10
|
import type { RegularFacet, RegularFacetState } from '../../../../controllers/commerce/core/facets/regular/headless-commerce-regular-facet.js';
|
|
11
11
|
import type { LocationFacetValue, RegularFacetValue } from '../../../../features/commerce/facets/facet-set/interfaces/response.js';
|
|
12
12
|
import { SolutionType } from '../../types/controller-constants.js';
|
|
13
|
-
import type {
|
|
13
|
+
import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
14
14
|
export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetState, CategoryFacetValue, CategoryFacetSearchResult, CoreCommerceFacet, DateFacet, DateFacetValue, DateFacetState, NumericFacet, NumericFacetValue, NumericFacetState, RegularFacet, RegularFacetState, RegularFacetValue, LocationFacet, LocationFacetState, LocationFacetValue, MappedGeneratedFacetController, };
|
|
15
15
|
export type FacetGeneratorState = MappedFacetStates;
|
|
16
16
|
export type MappedFacetStates = Array<MappedFacetState[FacetType]>;
|
|
@@ -18,10 +18,11 @@ export type { FacetType };
|
|
|
18
18
|
export type MappedFacetState = {
|
|
19
19
|
[T in FacetType]: T extends 'numericalRange' ? NumericFacetState : T extends 'regular' ? RegularFacetState : T extends 'dateRange' ? DateFacetState : T extends 'hierarchical' ? CategoryFacetState : T extends 'location' ? LocationFacetState : never;
|
|
20
20
|
};
|
|
21
|
+
export type FacetGeneratorDefinition = SearchAndListingControllerDefinitionWithoutProps<FacetGenerator>;
|
|
21
22
|
/**
|
|
22
23
|
* @group Definers
|
|
23
24
|
*/
|
|
24
|
-
export declare function defineFacetGenerator
|
|
25
|
+
export declare function defineFacetGenerator(): FacetGeneratorDefinition;
|
|
25
26
|
/**
|
|
26
27
|
* The `FacetGenerator` headless sub-controller creates commerce facet sub-controllers from the Commerce API search or
|
|
27
28
|
* product listing response.
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { type InstantProducts, type InstantProductsOptions, type InstantProductsProps, type InstantProductsState } from '../../../../controllers/commerce/instant-products/headless-instant-products.js';
|
|
2
2
|
import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { InstantProductsOptions, InstantProductsState, InstantProducts, InstantProductsProps, };
|
|
4
|
-
export
|
|
5
|
-
}
|
|
4
|
+
export type InstantProductsDefinition = NonRecommendationControllerDefinitionWithoutProps<InstantProducts>;
|
|
6
5
|
/**
|
|
7
6
|
* Defines the `InstantProducts` controller for the purpose of server-side rendering.
|
|
8
7
|
* @group Definers
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState } from '../../../../controllers/commerce/core/pagination/headless-core-commerce-pagination.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { Pagination, PaginationProps, PaginationState, PaginationOptions, CorePaginationOptions, };
|
|
4
|
+
export type PaginationDefinition = SearchAndListingControllerDefinitionWithoutProps<Pagination>;
|
|
4
5
|
/**
|
|
5
6
|
* Defines a `Pagination` controller instance.
|
|
6
7
|
* @group Definers
|
|
@@ -8,4 +9,4 @@ export type { Pagination, PaginationProps, PaginationState, PaginationOptions, C
|
|
|
8
9
|
* @param props - The configurable `Pagination` properties.
|
|
9
10
|
* @returns The `Pagination` controller definition.
|
|
10
11
|
*/
|
|
11
|
-
export declare function definePagination
|
|
12
|
+
export declare function definePagination(props?: PaginationProps): PaginationDefinition;
|
|
@@ -2,25 +2,15 @@ import type { ParameterManager, ParameterManagerProps, ParameterManagerState } f
|
|
|
2
2
|
import type { Parameters } from '../../../../features/commerce/parameters/parameters-actions.js';
|
|
3
3
|
import type { ProductListingParameters } from '../../../../features/commerce/product-listing-parameters/product-listing-parameters-actions.js';
|
|
4
4
|
import type { CommerceSearchParameters } from '../../../../features/commerce/search-parameters/search-parameters-actions.js';
|
|
5
|
-
import type {
|
|
5
|
+
import type { SearchAndListingControllerDefinitionWithProps } from '../../types/controller-definitions.js';
|
|
6
6
|
export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, };
|
|
7
|
-
export type ParameterManagerDefinition
|
|
7
|
+
export type ParameterManagerDefinition = SearchAndListingControllerDefinitionWithProps<ParameterManager<ProductListingParameters | CommerceSearchParameters>, SSRParameterManagerProps<ProductListingParameters | CommerceSearchParameters>>;
|
|
8
8
|
/**
|
|
9
9
|
* Defines a `ParameterManager` controller instance.
|
|
10
10
|
* @group Definers
|
|
11
11
|
*
|
|
12
12
|
* @returns The `ParameterManager` controller definition.
|
|
13
13
|
*/
|
|
14
|
-
export declare function defineParameterManager
|
|
14
|
+
export declare function defineParameterManager(): ParameterManagerDefinition;
|
|
15
15
|
export interface SSRParameterManagerProps<T extends Parameters> extends Omit<ParameterManagerProps<T>, 'excludeDefaultParameters'> {
|
|
16
16
|
}
|
|
17
|
-
type MappedParameterTypes<TOptions extends ControllerDefinitionOption | undefined> = TOptions extends {
|
|
18
|
-
listing: true;
|
|
19
|
-
search: true;
|
|
20
|
-
} | undefined ? ProductListingParameters | CommerceSearchParameters : TOptions extends {
|
|
21
|
-
listing: true;
|
|
22
|
-
search: false;
|
|
23
|
-
} ? ProductListingParameters : TOptions extends {
|
|
24
|
-
listing: false;
|
|
25
|
-
search: true;
|
|
26
|
-
} ? CommerceSearchParameters : never;
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
import { type ProductListing, type ProductListingState } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
|
|
2
2
|
import { type Search } from '../../../../controllers/commerce/search/headless-search.js';
|
|
3
|
-
import type {
|
|
3
|
+
import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
4
4
|
export type { Search, ProductListing, ProductListingState as ProductListState };
|
|
5
5
|
export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
|
|
6
|
+
export type ProductListDefinition = SearchAndListingControllerDefinitionWithoutProps<ProductList>;
|
|
6
7
|
/**
|
|
7
8
|
* Defines a `ProductList` controller instance.
|
|
8
9
|
* @group Definers
|
|
9
10
|
*
|
|
10
11
|
* @returns The `ProductList` controller definition.
|
|
11
12
|
*/
|
|
12
|
-
export declare function defineProductList
|
|
13
|
+
export declare function defineProductList(): ProductListDefinition;
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { type ProductView as BaseProductView } from '../../../../controllers/commerce/product-view/headless-product-view.js';
|
|
2
2
|
import { type Controller } from '../../../../controllers/controller/headless-controller.js';
|
|
3
3
|
import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
4
|
-
|
|
5
|
-
}
|
|
4
|
+
export type ProductViewDefinition = NonRecommendationControllerDefinitionWithoutProps<ProductView>;
|
|
6
5
|
/**
|
|
7
6
|
* Defines a `ProductView` controller instance.
|
|
8
7
|
*
|
|
@@ -17,4 +16,3 @@ interface ProductViewDefinition extends NonRecommendationControllerDefinitionWit
|
|
|
17
16
|
export declare function defineProductView(): ProductViewDefinition;
|
|
18
17
|
export interface ProductView extends BaseProductView, Controller {
|
|
19
18
|
}
|
|
20
|
-
export {};
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { type RecentQueriesList, type RecentQueriesListInitialState, type RecentQueriesListOptions, type RecentQueriesListProps, type RecentQueriesState } from '../../../../controllers/commerce/recent-queries-list/headless-recent-queries-list.js';
|
|
2
2
|
import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesState, RecentQueriesList, RecentQueriesListProps, };
|
|
4
|
-
export
|
|
5
|
-
}
|
|
4
|
+
export type RecentQueriesListDefinition = NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList>;
|
|
6
5
|
/**
|
|
7
6
|
* Defines the `RecentQueriesList` controller for the purpose of server-side rendering.
|
|
8
7
|
* @group Definers
|
|
@@ -1,13 +1,11 @@
|
|
|
1
|
-
import { type Recommendations, type RecommendationsOptions, type RecommendationsState } from '../../../../controllers/commerce/recommendations/headless-recommendations.js';
|
|
1
|
+
import { type Recommendations, type RecommendationsOptions, type RecommendationsProps, 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]: {} &
|
|
6
|
+
[recommendationInternalOptionKey]: {} & RecommendationsProps['options'];
|
|
7
7
|
};
|
|
8
|
-
export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, {
|
|
9
|
-
initialState: Partial<RecommendationsOptions>;
|
|
10
|
-
}> {
|
|
8
|
+
export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, Partial<RecommendationsOptions>> {
|
|
11
9
|
}
|
|
12
10
|
/**
|
|
13
11
|
* Defines a `Recommendations` controller instance.
|
|
@@ -16,6 +14,4 @@ export interface RecommendationsDefinition extends RecommendationOnlyControllerD
|
|
|
16
14
|
* @param props - The configurable `Recommendations` properties.
|
|
17
15
|
* @returns The `Recommendations` controller definition.
|
|
18
16
|
* */
|
|
19
|
-
export declare function defineRecommendations(props:
|
|
20
|
-
options: Omit<RecommendationsOptions, 'productId'>;
|
|
21
|
-
}): RecommendationsDefinition & RecommendationsDefinitionMeta;
|
|
17
|
+
export declare function defineRecommendations(props: RecommendationsProps): RecommendationsDefinition & RecommendationsDefinitionMeta;
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { type CoreSearchBox, type SearchBox, type SearchBoxOptions, type SearchBoxProps, type SearchBoxState, type Suggestion } from '../../../../controllers/commerce/search-box/headless-search-box.js';
|
|
2
2
|
import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { CoreSearchBox, SearchBox, SearchBoxProps, SearchBoxState, SearchBoxOptions, Suggestion, };
|
|
4
|
-
export
|
|
5
|
-
}
|
|
4
|
+
export type SearchBoxDefinition = SearchOnlyControllerDefinitionWithoutProps<SearchBox>;
|
|
6
5
|
/**
|
|
7
6
|
* Defines a `SearchBox` controller instance.
|
|
8
7
|
* @group Definers
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { Sort, SortProps, SortState } from '../../../../controllers/commerce/core/sort/headless-core-commerce-sort.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { Sort, SortProps, SortState };
|
|
4
|
+
export type SortDefinition = SearchAndListingControllerDefinitionWithoutProps<Sort>;
|
|
4
5
|
/**
|
|
5
6
|
* Defines a `Sort` controller instance.
|
|
6
7
|
* @group Definers
|
|
@@ -8,4 +9,4 @@ export type { Sort, SortProps, SortState };
|
|
|
8
9
|
* @param props - The configurable `Sort` properties.
|
|
9
10
|
* @returns The `Sort` controller definition.
|
|
10
11
|
*/
|
|
11
|
-
export declare function defineSort
|
|
12
|
+
export declare function defineSort(props?: SortProps): SortDefinition;
|
|
@@ -2,8 +2,7 @@ import { type StandaloneSearchBox, type StandaloneSearchBoxState } from '../../.
|
|
|
2
2
|
import type { StandaloneSearchBoxProps } from '../../../../controllers/standalone-search-box/headless-standalone-search-box.js';
|
|
3
3
|
import type { ListingAndStandaloneControllerWithoutProps } from '../../types/controller-definitions.js';
|
|
4
4
|
export type { StandaloneSearchBoxState, StandaloneSearchBox, StandaloneSearchBoxProps, };
|
|
5
|
-
export
|
|
6
|
-
}
|
|
5
|
+
export type StandaloneSearchBoxDefinition = ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox>;
|
|
7
6
|
/**
|
|
8
7
|
* Defines the `StandaloneSearchBox` controller for the purpose of server-side rendering.
|
|
9
8
|
* @group Definers
|
|
@@ -2,12 +2,13 @@ import type { Summary, SummaryState } from '../../../../controllers/commerce/cor
|
|
|
2
2
|
import type { ProductListingSummaryState } from '../../../../controllers/commerce/product-listing/summary/headless-product-listing-summary.js';
|
|
3
3
|
import type { RecommendationsSummaryState } from '../../../../controllers/commerce/recommendations/summary/headless-recommendations-summary.js';
|
|
4
4
|
import type { SearchSummaryState } from '../../../../controllers/commerce/search/summary/headless-search-summary.js';
|
|
5
|
-
import type {
|
|
5
|
+
import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
6
6
|
export type { Summary, ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, SummaryState, };
|
|
7
|
+
export type SummaryDefinition = SearchAndListingControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>>;
|
|
7
8
|
/**
|
|
8
9
|
* Defines a `Summary` controller instance.
|
|
9
10
|
* @group Definers
|
|
10
11
|
*
|
|
11
12
|
* @returns The `Summary` controller definition.
|
|
12
13
|
*/
|
|
13
|
-
export declare function defineSummary
|
|
14
|
+
export declare function defineSummary(): SummaryDefinition;
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import type { NotifyTrigger, NotifyTriggerState } from '../../../../controllers/core/triggers/headless-core-notify-trigger.js';
|
|
2
2
|
import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { NotifyTrigger, NotifyTriggerState };
|
|
4
|
-
export
|
|
5
|
-
}
|
|
4
|
+
export type NotifyTriggerDefinition = SearchAndListingControllerDefinitionWithoutProps<NotifyTrigger>;
|
|
6
5
|
/**
|
|
7
6
|
* Defines the `NotifyTrigger` controller for the purpose of server-side rendering.
|
|
8
7
|
* @group Definers
|
|
@@ -2,8 +2,7 @@ import type { QueryTrigger } from '../../../../controllers/core/triggers/headles
|
|
|
2
2
|
import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { QueryTriggerState } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
|
|
4
4
|
export type { QueryTrigger };
|
|
5
|
-
export
|
|
6
|
-
}
|
|
5
|
+
export type QueryTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<QueryTrigger>;
|
|
7
6
|
/**
|
|
8
7
|
* Defines the `QueryTrigger` controller for the purpose of server-side rendering.
|
|
9
8
|
* @group Definers
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import type { RedirectionTrigger, RedirectionTriggerState } from '../../../../controllers/core/triggers/headless-core-redirection-trigger.js';
|
|
2
2
|
import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
|
|
3
3
|
export type { RedirectionTrigger, RedirectionTriggerState };
|
|
4
|
-
export
|
|
5
|
-
}
|
|
4
|
+
export type RedirectionTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<RedirectionTrigger>;
|
|
6
5
|
/**
|
|
7
6
|
* Defines the `RedirectionTrigger` controller for the purpose of server-side rendering.
|
|
8
7
|
* @group Definers
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import type { Action } from '@reduxjs/toolkit';
|
|
2
2
|
import { type CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
|
|
3
3
|
import { SolutionType } from '../types/controller-constants.js';
|
|
4
|
-
import type {
|
|
4
|
+
import type { AugmentedControllerDefinition, BakedInControllers } from '../types/controller-definitions.js';
|
|
5
|
+
import type { InferControllersMapFromDefinition } from '../types/controller-inference.js';
|
|
6
|
+
import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateParameters, HydrateStaticStateParameters } from '../types/engine.js';
|
|
5
7
|
/**
|
|
6
8
|
* The SSR commerce engine.
|
|
7
9
|
*
|
|
@@ -13,7 +15,7 @@ export interface SSRCommerceEngine extends CommerceEngine {
|
|
|
13
15
|
*/
|
|
14
16
|
waitForRequestCompletedAction(): Promise<Action>[];
|
|
15
17
|
}
|
|
16
|
-
export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions
|
|
18
|
+
export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...[buildOptions]: FetchStaticStateParameters<TControllerDefinitions, TSolutionType> | HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
|
|
17
19
|
engine: SSRCommerceEngine;
|
|
18
|
-
controllers:
|
|
20
|
+
controllers: InferControllersMapFromDefinition<TControllerDefinitions, TSolutionType> & BakedInControllers;
|
|
19
21
|
}>;
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import type { SolutionType } from '../types/controller-constants.js';
|
|
2
2
|
import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
|
|
3
|
-
import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions,
|
|
4
|
-
export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType:
|
|
3
|
+
import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, HydrateStaticStateParameters } from '../types/engine.js';
|
|
4
|
+
export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...params: HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
|
|
5
|
+
engine: import("./build-factory.js").SSRCommerceEngine;
|
|
6
|
+
controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, TSolutionType> & import("../types/controller-definitions.js").BakedInControllers;
|
|
7
|
+
}>;
|
|
@@ -1,2 +1,4 @@
|
|
|
1
|
+
import { SolutionType } from '../types/controller-constants.js';
|
|
2
|
+
import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
|
|
1
3
|
import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, HydrateStaticStateFunction } from '../types/engine.js';
|
|
2
|
-
export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions
|
|
4
|
+
export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions, SolutionType.recommendation>;
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
import type { UnknownAction } from '@reduxjs/toolkit';
|
|
2
|
+
import { SolutionType } from '../types/controller-constants.js';
|
|
1
3
|
import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
|
|
2
|
-
import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions,
|
|
3
|
-
export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>):
|
|
4
|
+
import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateParameters } from '../types/engine.js';
|
|
5
|
+
export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (...params: FetchStaticStateParameters<TControllerDefinitions, SolutionType.recommendation>) => Promise<{
|
|
6
|
+
controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, SolutionType.recommendation> & import("../types/controller-definitions.js").FilteredBakedInControllers<SolutionType.recommendation>;
|
|
7
|
+
searchActions: UnknownAction[];
|
|
8
|
+
context: import("../../../commerce.index.js").ContextOptions;
|
|
9
|
+
searchParams?: import("../../../commerce.index.js").ParameterManagerState<import("../../../commerce.index.js").Parameters>["parameters"];
|
|
10
|
+
cart?: import("../../../commerce.index.js").CartInitialState;
|
|
11
|
+
productId?: string;
|
|
12
|
+
recommendations: Extract<keyof TControllerDefinitions, { [K in keyof TControllerDefinitions]: import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? never : K; }[keyof TControllerDefinitions]>[];
|
|
13
|
+
}>;
|
|
@@ -1,4 +1,9 @@
|
|
|
1
|
+
import type { UnknownAction } from '@reduxjs/toolkit';
|
|
2
|
+
import type { BuildConfig } from '../types/build.js';
|
|
1
3
|
import { SolutionType } from '../types/controller-constants.js';
|
|
2
4
|
import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
|
|
3
|
-
import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions,
|
|
4
|
-
export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType:
|
|
5
|
+
import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateParameters } from '../types/engine.js';
|
|
6
|
+
export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...params: FetchStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<BuildConfig<TControllerDefinitions, TSolutionType> & {
|
|
7
|
+
controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, TSolutionType> & import("../types/controller-definitions.js").FilteredBakedInControllers<TSolutionType>;
|
|
8
|
+
searchActions: UnknownAction[];
|
|
9
|
+
}>;
|
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
|
|
2
2
|
import type { Controller } from '../../../controllers/controller/headless-controller.js';
|
|
3
|
-
import type {
|
|
4
|
-
import type { HasKey, OptionsTuple } from '../../common/types/utilities.js';
|
|
3
|
+
import type { HasKey } from '../../common/types/utilities.js';
|
|
5
4
|
import type { CartInitialState } from '../controllers/cart/headless-cart.ssr.js';
|
|
6
5
|
import type { ContextOptions } from '../controllers/context/headless-context.ssr.js';
|
|
7
6
|
import type { ParameterManagerState, Parameters } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
|
|
8
7
|
import type { SolutionType } from './controller-constants.js';
|
|
9
|
-
import type {
|
|
10
|
-
import type { CommerceEngineDefinitionBuildResult } from './engine.js';
|
|
8
|
+
import type { ControllerDefinitionsMap, IsRecommendationController } from './controller-definitions.js';
|
|
11
9
|
export interface SearchBuildConfig extends CommonBuildConfig {
|
|
12
10
|
searchParams: ParameterManagerState<Parameters & {
|
|
13
11
|
query: string;
|
|
@@ -83,7 +81,3 @@ export interface CommonBuildConfig {
|
|
|
83
81
|
cart?: CartInitialState;
|
|
84
82
|
}
|
|
85
83
|
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;
|
|
86
|
-
/**
|
|
87
|
-
* @internal
|
|
88
|
-
*/
|
|
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>>;
|