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