@coveo/quantic 3.11.1 → 3.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/force-app/main/default/lwc/quanticBreadcrumbManager/__tests__/quanticBreadcrumbManager.test.js +326 -57
- package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/fixture.ts +76 -0
- package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/pageObject.ts +282 -0
- package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/quanticBreadcrumbManager.e2e.ts +167 -0
- package/force-app/main/default/lwc/quanticBreadcrumbManager/quanticBreadcrumbManager.html +10 -10
- package/force-app/main/default/lwc/quanticPager/e2e/fixture.ts +4 -4
- package/force-app/main/default/lwc/quanticTab/__tests__/quanticTab.test.js +287 -0
- package/force-app/main/default/lwc/quanticTab/e2e/fixture.ts +62 -0
- package/force-app/main/default/lwc/quanticTab/e2e/pageObject.ts +67 -0
- package/force-app/main/default/lwc/quanticTab/e2e/quanticTab.e2e.ts +77 -0
- package/force-app/main/default/lwc/quanticTab/quanticTab.html +1 -1
- package/force-app/main/default/lwc/quanticTabBar/__tests__/quanticTabBar.test.js +331 -0
- package/force-app/main/default/lwc/quanticTabBar/e2e/fixture.ts +61 -0
- package/force-app/main/default/lwc/quanticTabBar/e2e/pageObject.ts +80 -0
- package/force-app/main/default/lwc/quanticTabBar/e2e/quanticTabBar.e2e.ts +173 -0
- package/force-app/main/default/lwc/quanticTabBar/quanticTabBar.html +30 -8
- package/force-app/main/default/lwc/quanticTabBar/quanticTabBar.js +5 -4
- package/force-app/main/default/lwc/quanticUtils/__tests__/markdownUtils.test.js +1 -1
- package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +5 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search-api-params.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/case-assist-params.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/insight-params.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/kind.d.ts +3 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/undoable.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.ssr.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/example-deleteme-headless-case-context.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/actions-history/ipx-actions-history-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-utils.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-analytics-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/history/history-actions.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/pipeline/select-pipeline.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-selectors.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/question-answering/question-answering-document-id.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-actions.d.ts +42 -42
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +44 -44
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions.d.ts +42 -43
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-mappings.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +44 -44
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-hub/search-hub-selectors.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/selectors/commerce-selectors.index.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-search-request.d.ts +44 -44
- package/force-app/main/default/staticresources/coveoheadless/definitions/tsdoc-metadata.json +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/compare-utils.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/utils.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/validate-payload.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/headless.js +7 -7
- package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +6 -6
- package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +5 -5
- package/force-app/main/default/staticresources/marked/marked.min.js +3 -3
- package/package.json +6 -10
- /package/force-app/main/default/lwc/quanticPager/e2e/{pagerObject.ts → pageObject.ts} +0 -0
|
@@ -24,4 +24,4 @@ export declare const buildRequest: (req: CommerceAPIRequest, path: CommerceApiMe
|
|
|
24
24
|
origin: import("../../preprocess-request.js").PlatformClientOrigin;
|
|
25
25
|
requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
|
|
26
26
|
};
|
|
27
|
-
export declare const baseRequest: (req: BaseParam, path: CommerceApiMethod) => Pick<PlatformClientCallOptions,
|
|
27
|
+
export declare const baseRequest: (req: BaseParam, path: CommerceApiMethod) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin" | "requestMetadata">;
|
|
@@ -60,7 +60,7 @@ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[])
|
|
|
60
60
|
argsMemoize: typeof import("reselect").weakMapMemoize;
|
|
61
61
|
memoize: typeof import("reselect").weakMapMemoize;
|
|
62
62
|
};
|
|
63
|
-
export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage:
|
|
63
|
+
export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage: "fetch" | "select") => {
|
|
64
64
|
tab: string;
|
|
65
65
|
numberOfResults?: number | undefined;
|
|
66
66
|
firstResult?: number | undefined;
|
|
@@ -127,6 +127,6 @@ export interface GenQAParameters {
|
|
|
127
127
|
export interface ResponseFormatParameters {
|
|
128
128
|
contentFormat?: GeneratedContentFormat[];
|
|
129
129
|
}
|
|
130
|
-
export declare const baseSearchRequest: (req: BaseParam & AuthenticationParam, method: HttpMethods, contentType: HTTPContentType, path: string) => Pick<PlatformClientCallOptions,
|
|
130
|
+
export declare const baseSearchRequest: (req: BaseParam & AuthenticationParam, method: HttpMethods, contentType: HTTPContentType, path: string) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin">;
|
|
131
131
|
export declare const getOrganizationIdQueryParam: (req: BaseParam) => string;
|
|
132
132
|
export declare const getAuthenticationQueryParam: (req: AuthenticationParam) => string;
|
|
@@ -22,6 +22,6 @@ export type CaseAssistParam = BaseParam & CaseAssistIdParam;
|
|
|
22
22
|
* @param queryStringArguments - The arguments to pass in the query string.
|
|
23
23
|
* @returns The built request information.
|
|
24
24
|
*/
|
|
25
|
-
export declare const baseCaseAssistRequest: (req: CaseAssistParam, method: HttpMethods, contentType: HTTPContentType, path: string, queryStringArguments?: Record<string, string>) => Pick<PlatformClientCallOptions,
|
|
25
|
+
export declare const baseCaseAssistRequest: (req: CaseAssistParam, method: HttpMethods, contentType: HTTPContentType, path: string, queryStringArguments?: Record<string, string>) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin">;
|
|
26
26
|
export declare const prepareSuggestionRequestFields: (fields: CaseFields) => CaseFields;
|
|
27
27
|
export declare const prepareContextFromFields: (fields: CaseFields) => Record<string, string | string[]>;
|
|
@@ -7,6 +7,6 @@ export interface InsightIdParam {
|
|
|
7
7
|
export type InsightParam = BaseParam & InsightIdParam;
|
|
8
8
|
export declare const baseInsightUrl: (req: InsightParam, path?: string) => string;
|
|
9
9
|
export declare const baseInsightUserActionsUrl: (req: InsightUserActionsRequest) => string;
|
|
10
|
-
export declare const baseInsightRequest: (req: InsightParam, method: HttpMethods, contentType: HTTPContentType, path: string) => Pick<PlatformClientCallOptions,
|
|
11
|
-
export declare const baseInsightUserActionRequest: (req: InsightUserActionsRequest, method: HttpMethods, contentType: HTTPContentType) => Pick<PlatformClientCallOptions,
|
|
10
|
+
export declare const baseInsightRequest: (req: InsightParam, method: HttpMethods, contentType: HTTPContentType, path: string) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin">;
|
|
11
|
+
export declare const baseInsightUserActionRequest: (req: InsightUserActionsRequest, method: HttpMethods, contentType: HTTPContentType) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin">;
|
|
12
12
|
export declare const pickNonInsightParams: (req: InsightParam) => {};
|
|
@@ -5,8 +5,6 @@ export interface StateWithHistory<State> {
|
|
|
5
5
|
present?: State;
|
|
6
6
|
future: State[];
|
|
7
7
|
}
|
|
8
|
-
declare const undo: <State>(state: StateWithHistory<State>) => StateWithHistory<State>;
|
|
9
|
-
declare const redo: <State>(state: StateWithHistory<State>) => StateWithHistory<State>;
|
|
10
8
|
export declare const undoable: <State>(options: {
|
|
11
9
|
reducer: Reducer<State>;
|
|
12
10
|
actionTypes: {
|
|
@@ -15,4 +13,3 @@ export declare const undoable: <State>(options: {
|
|
|
15
13
|
snapshot: string;
|
|
16
14
|
};
|
|
17
15
|
}) => (state: StateWithHistory<State> | undefined, action: AnyAction) => StateWithHistory<State>;
|
|
18
|
-
export {};
|
|
@@ -3,4 +3,5 @@ import type { Summary } from '../../core/summary/headless-core-summary.js';
|
|
|
3
3
|
import type { ProductListingSummaryState } from '../../product-listing/summary/headless-product-listing-summary.js';
|
|
4
4
|
import { SearchSummaryState } from '../../search/summary/headless-search-summary.js';
|
|
5
5
|
export type { ProductListingSummaryState, Summary };
|
|
6
|
-
export declare function defineQuerySummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState & SearchSummaryState>,
|
|
6
|
+
export declare function defineQuerySummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState & SearchSummaryState>, // TODO: fix conditional typing to return the appropriate type based on current solution type
|
|
7
|
+
TOptions>;
|
|
@@ -29,4 +29,4 @@ export interface CaseContextState extends CoreContextState {
|
|
|
29
29
|
caseNumber: string;
|
|
30
30
|
}
|
|
31
31
|
export type CaseContextControllerState = CaseContext['state'];
|
|
32
|
-
export declare const createCaseContext: (engine: CoreEngine
|
|
32
|
+
export declare const createCaseContext: (engine: CoreEngine, props: ContextProps) => CaseContext, mixinCaseContext: <InputContext extends CoreContext>(engine: CoreEngine, props: ContextProps, context: InputContext) => InputContext & CaseContext;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export declare const addPageViewEntryInActionsHistory: import("@reduxjs/toolkit").AsyncThunk<void, string, {
|
|
2
2
|
state?: unknown;
|
|
3
|
-
dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction
|
|
3
|
+
dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
|
|
4
4
|
extra?: unknown;
|
|
5
5
|
rejectValue?: unknown;
|
|
6
6
|
serializedErrorType?: unknown;
|
|
@@ -66,15 +66,15 @@ type InternalLegacyStateNeeded = StateNeededBySearchAnalyticsProvider | StateNee
|
|
|
66
66
|
type LogFunction<Client, StateNeeded> = (client: Client, state: StateNeeded) => Promise<void | SearchEventResponse> | void | null;
|
|
67
67
|
export declare const makeAnalyticsAction: {
|
|
68
68
|
<LegacyStateNeeded extends StateNeededBySearchAnalyticsProvider = StateNeededBySearchAnalyticsProvider, ComputedLegacyAnalyticsOptions extends LegacyAnalyticsOptions<LegacyStateNeeded, CoveoSearchPageClient, SearchPageClientProvider> = LegacyAnalyticsOptions<LegacyStateNeeded, CoveoSearchPageClient, SearchPageClientProvider>>(prefix: string, __legacy__getBuilder: (client: CoveoSearchPageClient, state: StateNeededBySearchAnalyticsProvider) => Promise<EventBuilder | null> | null, __legacy__provider?: ComputedLegacyAnalyticsOptions["__legacy__provider"] | undefined): PreparableAnalyticsAction<LegacyStateNeeded>;
|
|
69
|
-
<
|
|
69
|
+
<LegacyStateNeeded extends StateNeededBySearchAnalyticsProvider = StateNeededBySearchAnalyticsProvider, StateNeeded extends StateNeededBySearchAnalyticsProvider = StateNeededBySearchAnalyticsProvider, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded, StateNeeded, (client: CoveoSearchPageClient, state: StateNeededBySearchAnalyticsProvider) => Promise<EventBuilder | null> | null, SearchPageClientProvider, CoveoSearchPageClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
|
|
70
70
|
};
|
|
71
71
|
export declare const makeCaseAssistAnalyticsAction: {
|
|
72
72
|
<LegacyStateNeeded extends StateNeededByCaseAssistAnalytics = StateNeededByCaseAssistAnalytics, ComputedLegacyAnalyticsOptions extends LegacyAnalyticsOptions<LegacyStateNeeded, CaseAssistClient, CaseAssistAnalyticsProvider> = LegacyAnalyticsOptions<LegacyStateNeeded, CaseAssistClient, CaseAssistAnalyticsProvider>>(prefix: string, __legacy__getBuilder: LogFunction<CaseAssistClient, StateNeededByCaseAssistAnalytics>, __legacy__provider?: ComputedLegacyAnalyticsOptions["__legacy__provider"] | undefined): PreparableAnalyticsAction<LegacyStateNeeded>;
|
|
73
|
-
<
|
|
73
|
+
<LegacyStateNeeded extends StateNeededByCaseAssistAnalytics = StateNeededByCaseAssistAnalytics, StateNeeded extends StateNeededByCaseAssistAnalytics = StateNeededByCaseAssistAnalytics, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded, StateNeeded, LogFunction<CaseAssistClient, StateNeededByCaseAssistAnalytics>, CaseAssistAnalyticsProvider, CaseAssistClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
|
|
74
74
|
};
|
|
75
75
|
export declare const makeInsightAnalyticsActionFactory: (actionCause: string) => {
|
|
76
76
|
<LegacyStateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, ComputedLegacyAnalyticsOptions extends LegacyAnalyticsOptions<LegacyStateNeeded, CoveoInsightClient, InsightAnalyticsProvider> = LegacyAnalyticsOptions<LegacyStateNeeded, CoveoInsightClient, InsightAnalyticsProvider>>(prefix: string, __legacy__getBuilder: LogFunction<CoveoInsightClient, StateNeededByInsightAnalyticsProvider>, __legacy__provider?: ComputedLegacyAnalyticsOptions["__legacy__provider"] | undefined): PreparableAnalyticsAction<LegacyStateNeeded>;
|
|
77
|
-
<
|
|
77
|
+
<LegacyStateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, StateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded, StateNeeded, LogFunction<CoveoInsightClient, StateNeededByInsightAnalyticsProvider>, InsightAnalyticsProvider, CoveoInsightClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
|
|
78
78
|
};
|
|
79
79
|
export declare const makeNoopAnalyticsAction: () => PreparableAnalyticsAction<StateNeededBySearchAnalyticsProvider>;
|
|
80
80
|
export declare const noopSearchAnalyticsAction: () => LegacySearchAction;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { SearchParameterKey } from '../../search-parameters/search-parameter-serializer.js';
|
|
2
|
+
import { ProductListingParameters } from '../product-listing-parameters/product-listing-parameters-actions.js';
|
|
2
3
|
import { CommerceSearchParameters } from '../search-parameters/search-parameters-actions.js';
|
|
3
4
|
import { SortCriterion } from '../sort/sort.js';
|
|
4
5
|
import { Parameters } from './parameters-actions.js';
|
|
@@ -8,7 +9,7 @@ export interface Serializer<T extends Parameters> {
|
|
|
8
9
|
deserialize: (fragment: string) => T;
|
|
9
10
|
}
|
|
10
11
|
export declare const searchSerializer: Serializer<CommerceSearchParameters>;
|
|
11
|
-
export declare const productListingSerializer: Serializer<
|
|
12
|
+
export declare const productListingSerializer: Serializer<ProductListingParameters>;
|
|
12
13
|
export type ParametersKey = keyof CommerceSearchParameters;
|
|
13
14
|
export type FacetParameters = keyof Pick<Parameters, 'f' | 'fExcluded' | 'lf' | 'cf' | 'nf' | 'nfExcluded' | 'df' | 'dfExcluded' | 'mnf' | 'mnfExcluded'>;
|
|
14
15
|
type FacetKey = keyof typeof supportedFacetParameters;
|
|
@@ -10,7 +10,7 @@ export type GeneratedAnswerFeedback = {
|
|
|
10
10
|
details?: string;
|
|
11
11
|
documentUrl?: string;
|
|
12
12
|
};
|
|
13
|
-
export declare const parseEvaluationDetails: (detail:
|
|
13
|
+
export declare const parseEvaluationDetails: (detail: "yes" | "no" | "unknown") => boolean | undefined;
|
|
14
14
|
export declare const logRetryGeneratedAnswer: () => LegacySearchAction;
|
|
15
15
|
export declare const logOpenGeneratedAnswerSource: (citationId: string) => CustomAction;
|
|
16
16
|
export declare const logHoverCitation: (citationId: string, citationHoverTimeInMs: number) => CustomAction;
|
|
@@ -4,7 +4,7 @@ export declare const redo: import("@reduxjs/toolkit").ActionCreatorWithoutPayloa
|
|
|
4
4
|
export declare const snapshot: import("@reduxjs/toolkit").ActionCreatorWithPayload<HistoryState, string>;
|
|
5
5
|
export declare const back: import("@reduxjs/toolkit").AsyncThunk<void, void, {
|
|
6
6
|
state?: unknown;
|
|
7
|
-
dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction
|
|
7
|
+
dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
|
|
8
8
|
extra?: unknown;
|
|
9
9
|
rejectValue?: unknown;
|
|
10
10
|
serializedErrorType?: unknown;
|
|
@@ -14,7 +14,7 @@ export declare const back: import("@reduxjs/toolkit").AsyncThunk<void, void, {
|
|
|
14
14
|
}>;
|
|
15
15
|
export declare const forward: import("@reduxjs/toolkit").AsyncThunk<void, void, {
|
|
16
16
|
state?: unknown;
|
|
17
|
-
dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction
|
|
17
|
+
dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
|
|
18
18
|
extra?: unknown;
|
|
19
19
|
rejectValue?: unknown;
|
|
20
20
|
serializedErrorType?: unknown;
|
|
@@ -24,7 +24,7 @@ export declare const forward: import("@reduxjs/toolkit").AsyncThunk<void, void,
|
|
|
24
24
|
}>;
|
|
25
25
|
export declare const change: import("@reduxjs/toolkit").AsyncThunk<HistoryState | undefined, void, {
|
|
26
26
|
state?: unknown;
|
|
27
|
-
dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction
|
|
27
|
+
dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
|
|
28
28
|
extra?: unknown;
|
|
29
29
|
rejectValue?: unknown;
|
|
30
30
|
serializedErrorType?: unknown;
|
|
@@ -10,5 +10,5 @@ export declare const uniqueIdentifierPayloadDefinition: () => RecordValue;
|
|
|
10
10
|
export declare const inlineLinkPayloadDefinition: () => RecordValue;
|
|
11
11
|
export declare function validateQuestionAnsweringActionCreatorPayload(payload: QuestionAnsweringUniqueIdentifierActionCreatorPayload): {
|
|
12
12
|
payload: QuestionAnsweringUniqueIdentifierActionCreatorPayload;
|
|
13
|
-
error?: import("@reduxjs/toolkit").SerializedError
|
|
13
|
+
error?: import("@reduxjs/toolkit").SerializedError;
|
|
14
14
|
};
|
|
@@ -90,63 +90,63 @@ export declare const fetchInstantResults: import("@reduxjs/toolkit").AsyncThunk<
|
|
|
90
90
|
export declare const buildInstantResultSearchRequest: (state: StateNeededByExecuteSearch, q: string, numberOfResults: number) => Promise<MappedSearchRequest<{
|
|
91
91
|
numberOfResults: number;
|
|
92
92
|
q: string;
|
|
93
|
-
enableDidYouMean?: boolean
|
|
93
|
+
enableDidYouMean?: boolean;
|
|
94
94
|
url: string;
|
|
95
95
|
accessToken: string;
|
|
96
96
|
organizationId: string;
|
|
97
|
-
aq?: string
|
|
98
|
-
cq?: string
|
|
99
|
-
lq?: string
|
|
100
|
-
dq?: string
|
|
101
|
-
firstResult?: number
|
|
102
|
-
sortCriteria?: string
|
|
103
|
-
facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[]
|
|
104
|
-
context?: Record<string, string | string[]
|
|
105
|
-
dictionaryFieldContext?: Record<string, string
|
|
97
|
+
aq?: string;
|
|
98
|
+
cq?: string;
|
|
99
|
+
lq?: string;
|
|
100
|
+
dq?: string;
|
|
101
|
+
firstResult?: number;
|
|
102
|
+
sortCriteria?: string;
|
|
103
|
+
facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
|
|
104
|
+
context?: Record<string, string | string[]>;
|
|
105
|
+
dictionaryFieldContext?: Record<string, string>;
|
|
106
106
|
queryCorrection?: {
|
|
107
|
-
enabled?: boolean
|
|
107
|
+
enabled?: boolean;
|
|
108
108
|
options?: {
|
|
109
|
-
automaticallyCorrect?: "never" | "whenNoResults"
|
|
110
|
-
}
|
|
111
|
-
}
|
|
112
|
-
enableQuerySyntax?: boolean
|
|
113
|
-
fieldsToInclude?: string[]
|
|
114
|
-
pipeline?: string
|
|
115
|
-
searchHub?: string
|
|
116
|
-
facetOptions?: import("../../facet-options/facet-options.js").FacetOptions
|
|
117
|
-
debug?: boolean
|
|
118
|
-
locale?: string
|
|
119
|
-
filterField?: string
|
|
120
|
-
parentField?: string
|
|
121
|
-
childField?: string
|
|
122
|
-
filterFieldRange?: number
|
|
109
|
+
automaticallyCorrect?: "never" | "whenNoResults";
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
enableQuerySyntax?: boolean;
|
|
113
|
+
fieldsToInclude?: string[];
|
|
114
|
+
pipeline?: string;
|
|
115
|
+
searchHub?: string;
|
|
116
|
+
facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
|
|
117
|
+
debug?: boolean;
|
|
118
|
+
locale?: string;
|
|
119
|
+
filterField?: string;
|
|
120
|
+
parentField?: string;
|
|
121
|
+
childField?: string;
|
|
122
|
+
filterFieldRange?: number;
|
|
123
123
|
tab: string;
|
|
124
124
|
referrer: string | null;
|
|
125
125
|
timezone: string;
|
|
126
126
|
analytics?: {
|
|
127
|
-
actionCause?: string
|
|
128
|
-
customData?: object
|
|
127
|
+
actionCause?: string;
|
|
128
|
+
customData?: object;
|
|
129
129
|
clientId: string;
|
|
130
|
-
deviceId?: string
|
|
131
|
-
pageId?: string
|
|
130
|
+
deviceId?: string;
|
|
131
|
+
pageId?: string;
|
|
132
132
|
clientTimestamp: string;
|
|
133
133
|
documentReferrer: string | null;
|
|
134
134
|
originContext: string;
|
|
135
|
-
userDisplayName?: string
|
|
136
|
-
documentLocation?: string | null
|
|
137
|
-
trackingId?: string
|
|
138
|
-
capture?: boolean
|
|
139
|
-
source?: string[]
|
|
140
|
-
}
|
|
141
|
-
excerptLength?: number
|
|
142
|
-
actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[]
|
|
143
|
-
authentication?: string
|
|
135
|
+
userDisplayName?: string;
|
|
136
|
+
documentLocation?: string | null;
|
|
137
|
+
trackingId?: string;
|
|
138
|
+
capture?: boolean;
|
|
139
|
+
source?: string[];
|
|
140
|
+
};
|
|
141
|
+
excerptLength?: number;
|
|
142
|
+
actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
|
|
143
|
+
authentication?: string;
|
|
144
144
|
generateAutomaticFacets?: {
|
|
145
145
|
desiredCount: number;
|
|
146
|
-
numberOfValues?: number
|
|
147
|
-
currentFacets?: import("../../facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[]
|
|
148
|
-
}
|
|
149
|
-
pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters
|
|
146
|
+
numberOfValues?: number;
|
|
147
|
+
currentFacets?: import("../../facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[];
|
|
148
|
+
};
|
|
149
|
+
pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters;
|
|
150
150
|
}>>;
|
|
151
151
|
export declare function legacyFetchInstantResults(payload: FetchInstantResultsActionCreatorPayload, config: any): Promise<any>;
|
|
152
152
|
export declare function legacyFetchPage(state: StateNeededByExecuteSearch, config: any, //eslint-disable-line @typescript-eslint/no-explicit-any
|
|
@@ -4,64 +4,64 @@ import { ConfigurationSection } from '../../../state/state-sections.js';
|
|
|
4
4
|
import { AutomaticFacetRequest } from '../../facets/automatic-facet-set/interfaces/request.js';
|
|
5
5
|
type StateNeededBySearchRequest = ConfigurationSection & Partial<SearchAppState>;
|
|
6
6
|
export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eventDescription?: EventDescription) => Promise<import("../search-mappings.js").MappedSearchRequest<{
|
|
7
|
-
pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters
|
|
7
|
+
pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters;
|
|
8
8
|
generateAutomaticFacets?: {
|
|
9
9
|
desiredCount: number;
|
|
10
|
-
numberOfValues?: number
|
|
11
|
-
currentFacets?: AutomaticFacetRequest[]
|
|
12
|
-
}
|
|
13
|
-
filterField?: string
|
|
14
|
-
childField?: string
|
|
15
|
-
parentField?: string
|
|
16
|
-
filterFieldRange?: number
|
|
17
|
-
facetOptions?: import("../../facet-options/facet-options.js").FacetOptions
|
|
18
|
-
numberOfResults?: number
|
|
19
|
-
firstResult?: number
|
|
20
|
-
facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[]
|
|
21
|
-
cq?: string
|
|
10
|
+
numberOfValues?: number;
|
|
11
|
+
currentFacets?: AutomaticFacetRequest[];
|
|
12
|
+
};
|
|
13
|
+
filterField?: string;
|
|
14
|
+
childField?: string;
|
|
15
|
+
parentField?: string;
|
|
16
|
+
filterFieldRange?: number;
|
|
17
|
+
facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
|
|
18
|
+
numberOfResults?: number;
|
|
19
|
+
firstResult?: number;
|
|
20
|
+
facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
|
|
21
|
+
cq?: string;
|
|
22
22
|
queryCorrection?: {
|
|
23
|
-
enabled?: boolean
|
|
23
|
+
enabled?: boolean;
|
|
24
24
|
options?: {
|
|
25
|
-
automaticallyCorrect?: "never" | "whenNoResults"
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
enableDidYouMean?: boolean
|
|
25
|
+
automaticallyCorrect?: "never" | "whenNoResults";
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
enableDidYouMean?: boolean;
|
|
29
29
|
url: string;
|
|
30
30
|
accessToken: string;
|
|
31
31
|
organizationId: string;
|
|
32
|
-
q?: string
|
|
33
|
-
aq?: string
|
|
34
|
-
lq?: string
|
|
35
|
-
dq?: string
|
|
36
|
-
sortCriteria?: string
|
|
37
|
-
context?: Record<string, string | string[]
|
|
38
|
-
dictionaryFieldContext?: Record<string, string
|
|
39
|
-
enableQuerySyntax?: boolean
|
|
40
|
-
fieldsToInclude?: string[]
|
|
41
|
-
pipeline?: string
|
|
42
|
-
searchHub?: string
|
|
43
|
-
debug?: boolean
|
|
44
|
-
locale?: string
|
|
32
|
+
q?: string;
|
|
33
|
+
aq?: string;
|
|
34
|
+
lq?: string;
|
|
35
|
+
dq?: string;
|
|
36
|
+
sortCriteria?: string;
|
|
37
|
+
context?: Record<string, string | string[]>;
|
|
38
|
+
dictionaryFieldContext?: Record<string, string>;
|
|
39
|
+
enableQuerySyntax?: boolean;
|
|
40
|
+
fieldsToInclude?: string[];
|
|
41
|
+
pipeline?: string;
|
|
42
|
+
searchHub?: string;
|
|
43
|
+
debug?: boolean;
|
|
44
|
+
locale?: string;
|
|
45
45
|
tab: string;
|
|
46
46
|
referrer: string | null;
|
|
47
47
|
timezone: string;
|
|
48
48
|
analytics?: {
|
|
49
|
-
actionCause?: string
|
|
50
|
-
customData?: object
|
|
49
|
+
actionCause?: string;
|
|
50
|
+
customData?: object;
|
|
51
51
|
clientId: string;
|
|
52
|
-
deviceId?: string
|
|
53
|
-
pageId?: string
|
|
52
|
+
deviceId?: string;
|
|
53
|
+
pageId?: string;
|
|
54
54
|
clientTimestamp: string;
|
|
55
55
|
documentReferrer: string | null;
|
|
56
56
|
originContext: string;
|
|
57
|
-
userDisplayName?: string
|
|
58
|
-
documentLocation?: string | null
|
|
59
|
-
trackingId?: string
|
|
60
|
-
capture?: boolean
|
|
61
|
-
source?: string[]
|
|
62
|
-
}
|
|
63
|
-
excerptLength?: number
|
|
64
|
-
actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[]
|
|
65
|
-
authentication?: string
|
|
57
|
+
userDisplayName?: string;
|
|
58
|
+
documentLocation?: string | null;
|
|
59
|
+
trackingId?: string;
|
|
60
|
+
capture?: boolean;
|
|
61
|
+
source?: string[];
|
|
62
|
+
};
|
|
63
|
+
excerptLength?: number;
|
|
64
|
+
actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
|
|
65
|
+
authentication?: string;
|
|
66
66
|
}>>;
|
|
67
67
|
export {};
|
|
@@ -97,62 +97,61 @@ export declare const fetchInstantResults: import("@reduxjs/toolkit").AsyncThunk<
|
|
|
97
97
|
export declare const buildInstantResultSearchRequest: (state: StateNeededByExecuteSearch, navigatorContext: NavigatorContext, q: string, numberOfResults: number, eventDescription: EventDescription) => Promise<MappedSearchRequest<{
|
|
98
98
|
numberOfResults: number;
|
|
99
99
|
q: string;
|
|
100
|
-
enableDidYouMean?: boolean
|
|
100
|
+
enableDidYouMean?: boolean;
|
|
101
101
|
url: string;
|
|
102
102
|
accessToken: string;
|
|
103
103
|
organizationId: string;
|
|
104
|
-
aq?: string
|
|
105
|
-
cq?: string
|
|
106
|
-
lq?: string
|
|
107
|
-
dq?: string
|
|
108
|
-
firstResult?: number
|
|
109
|
-
sortCriteria?: string
|
|
110
|
-
facets?: import("../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[]
|
|
111
|
-
context?: Record<string, string | string[]
|
|
112
|
-
dictionaryFieldContext?: Record<string, string
|
|
104
|
+
aq?: string;
|
|
105
|
+
cq?: string;
|
|
106
|
+
lq?: string;
|
|
107
|
+
dq?: string;
|
|
108
|
+
firstResult?: number;
|
|
109
|
+
sortCriteria?: string;
|
|
110
|
+
facets?: import("../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
|
|
111
|
+
context?: Record<string, string | string[]>;
|
|
112
|
+
dictionaryFieldContext?: Record<string, string>;
|
|
113
113
|
queryCorrection?: {
|
|
114
|
-
enabled?: boolean
|
|
114
|
+
enabled?: boolean;
|
|
115
115
|
options?: {
|
|
116
|
-
automaticallyCorrect?: "never" | "whenNoResults"
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
enableQuerySyntax?: boolean
|
|
120
|
-
fieldsToInclude?: string[]
|
|
121
|
-
pipeline?: string
|
|
122
|
-
searchHub?: string
|
|
123
|
-
facetOptions?: import("../facet-options/facet-options.js").FacetOptions
|
|
124
|
-
debug?: boolean
|
|
125
|
-
locale?: string
|
|
126
|
-
filterField?: string
|
|
127
|
-
parentField?: string
|
|
128
|
-
childField?: string
|
|
129
|
-
filterFieldRange?: number
|
|
116
|
+
automaticallyCorrect?: "never" | "whenNoResults";
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
enableQuerySyntax?: boolean;
|
|
120
|
+
fieldsToInclude?: string[];
|
|
121
|
+
pipeline?: string;
|
|
122
|
+
searchHub?: string;
|
|
123
|
+
facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
|
|
124
|
+
debug?: boolean;
|
|
125
|
+
locale?: string;
|
|
126
|
+
filterField?: string;
|
|
127
|
+
parentField?: string;
|
|
128
|
+
childField?: string;
|
|
129
|
+
filterFieldRange?: number;
|
|
130
130
|
tab: string;
|
|
131
131
|
referrer: string | null;
|
|
132
|
-
/** The query that was executed. */
|
|
133
132
|
timezone: string;
|
|
134
133
|
analytics?: {
|
|
135
|
-
actionCause?: string
|
|
136
|
-
customData?: object
|
|
134
|
+
actionCause?: string;
|
|
135
|
+
customData?: object;
|
|
137
136
|
clientId: string;
|
|
138
|
-
deviceId?: string
|
|
139
|
-
pageId?: string
|
|
137
|
+
deviceId?: string;
|
|
138
|
+
pageId?: string;
|
|
140
139
|
clientTimestamp: string;
|
|
141
140
|
documentReferrer: string | null;
|
|
142
141
|
originContext: string;
|
|
143
|
-
userDisplayName?: string
|
|
144
|
-
documentLocation?: string | null
|
|
145
|
-
trackingId?: string
|
|
146
|
-
capture?: boolean
|
|
147
|
-
source?: string[]
|
|
148
|
-
}
|
|
149
|
-
excerptLength?: number
|
|
150
|
-
actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[]
|
|
151
|
-
authentication?: string
|
|
142
|
+
userDisplayName?: string;
|
|
143
|
+
documentLocation?: string | null;
|
|
144
|
+
trackingId?: string;
|
|
145
|
+
capture?: boolean;
|
|
146
|
+
source?: string[];
|
|
147
|
+
};
|
|
148
|
+
excerptLength?: number;
|
|
149
|
+
actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
|
|
150
|
+
authentication?: string;
|
|
152
151
|
generateAutomaticFacets?: {
|
|
153
152
|
desiredCount: number;
|
|
154
|
-
numberOfValues?: number
|
|
155
|
-
currentFacets?: import("../facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[]
|
|
156
|
-
}
|
|
157
|
-
pipelineRuleParameters?: import("../../api/search/search-api-params.js").PipelineRuleParameters
|
|
153
|
+
numberOfValues?: number;
|
|
154
|
+
currentFacets?: import("../facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[];
|
|
155
|
+
};
|
|
156
|
+
pipelineRuleParameters?: import("../../api/search/search-api-params.js").PipelineRuleParameters;
|
|
158
157
|
}>>;
|
|
@@ -13,7 +13,7 @@ export declare function mapFacetRequest(facetRequest: AnyFacetRequest, mappings:
|
|
|
13
13
|
start: string;
|
|
14
14
|
end: string;
|
|
15
15
|
endInclusive: boolean;
|
|
16
|
-
state: import("
|
|
16
|
+
state: import("../../ssr.index.js").FacetValueState;
|
|
17
17
|
}[];
|
|
18
18
|
sortCriteria: import("../../ssr.index.js").RangeFacetSortCriterion;
|
|
19
19
|
rangeAlgorithm: import("../../ssr.index.js").RangeFacetRangeAlgorithm;
|