@coveo/quantic 3.30.0-pre.ed4727df41 → 3.30.0-pre.f3b080233d
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/api-client-utils.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +3 -93
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts +4 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer-mocks.d.ts +2003 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/utils/testingUtils.d.ts +8 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/answer-api-selectors.d.ts +72 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts +2005 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-state.d.ts +5 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +2 -0
- 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/common/types/hydrate-static-state.d.ts +4 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts +8 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controller-utils.d.ts +1 -2
- 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/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/types/controller-definitions.d.ts +3 -48
- 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 +3 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/fetch-static-state.d.ts +1 -1
- 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/engine.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/controller-utils.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/types/hydrate-static-state.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 +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts +0 -1051
package/force-app/main/default/staticresources/coveoheadless/definitions/api/api-client-utils.d.ts
CHANGED
|
@@ -3,5 +3,5 @@ import type { BaseParam } from './platform-service-params.js';
|
|
|
3
3
|
import type { AllSearchAPIResponse } from './search/search-api-client.js';
|
|
4
4
|
import type { SearchAPIErrorWithStatusCode } from './search/search-api-error-response.js';
|
|
5
5
|
import type { AuthenticationParam } from './search/search-api-params.js';
|
|
6
|
-
export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "
|
|
6
|
+
export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "url" | "accessToken" | "organizationId" | "authentication">;
|
|
7
7
|
export declare const unwrapError: (payload: PlatformResponse<AllSearchAPIResponse>) => SearchAPIErrorWithStatusCode;
|
|
@@ -28,11 +28,11 @@ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path
|
|
|
28
28
|
facets: import("../../../features/commerce/facets/facet-set/interfaces/request.js").AnyFacetRequest[] | undefined;
|
|
29
29
|
sort: import("./sort.js").SortOption | undefined;
|
|
30
30
|
};
|
|
31
|
+
url: string;
|
|
32
|
+
origin: import("../../preprocess-request.js").PlatformClientOrigin;
|
|
31
33
|
accessToken: string;
|
|
32
34
|
method: import("../../platform-client.js").HttpMethods;
|
|
33
35
|
contentType: import("../../platform-client.js").HTTPContentType;
|
|
34
|
-
url: string;
|
|
35
|
-
origin: import("../../preprocess-request.js").PlatformClientOrigin;
|
|
36
36
|
requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
|
|
37
37
|
};
|
|
38
38
|
export declare const baseRequest: (req: BaseParam, path: CommerceApiMethod) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin" | "requestMetadata">;
|
|
@@ -24,10 +24,10 @@ export declare const buildRecommendationsRequest: (req: CommerceRecommendationsR
|
|
|
24
24
|
page: number | undefined;
|
|
25
25
|
perPage: number | undefined;
|
|
26
26
|
};
|
|
27
|
+
url: string;
|
|
28
|
+
origin: import("../../preprocess-request.js").PlatformClientOrigin;
|
|
27
29
|
accessToken: string;
|
|
28
30
|
method: import("../../platform-client.js").HttpMethods;
|
|
29
31
|
contentType: import("../../platform-client.js").HTTPContentType;
|
|
30
|
-
url: string;
|
|
31
|
-
origin: import("../../preprocess-request.js").PlatformClientOrigin;
|
|
32
32
|
requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
|
|
33
33
|
};
|
|
@@ -21,10 +21,10 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
|
|
|
21
21
|
country: string;
|
|
22
22
|
currency: string;
|
|
23
23
|
};
|
|
24
|
+
url: string;
|
|
25
|
+
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
24
26
|
accessToken: string;
|
|
25
27
|
method: import("../../../platform-client.js").HttpMethods;
|
|
26
28
|
contentType: import("../../../platform-client.js").HTTPContentType;
|
|
27
|
-
url: string;
|
|
28
|
-
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
29
29
|
requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
|
|
30
30
|
};
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { type NavigatorContext } from '../../app/navigator-context-provider.js';
|
|
1
|
+
import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
|
|
3
2
|
import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
|
|
4
3
|
import type { SearchRequest } from '../search/search/search-request.js';
|
|
5
4
|
import type { GeneratedAnswerStream } from './generated-answer-stream.js';
|
|
@@ -8,97 +7,8 @@ export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: Ge
|
|
|
8
7
|
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, {}>, {
|
|
9
8
|
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">;
|
|
10
9
|
}, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
|
|
11
|
-
export declare const
|
|
12
|
-
|
|
13
|
-
requestId: any;
|
|
14
|
-
cannotAnswer: any;
|
|
15
|
-
analyticsMode: any;
|
|
16
|
-
actionCause: any;
|
|
17
|
-
}) & {
|
|
18
|
-
clearCache: () => void;
|
|
19
|
-
resultsCount: () => number;
|
|
20
|
-
resetResultsCount: () => void;
|
|
21
|
-
} & {
|
|
22
|
-
resultFunc: (...resultFuncArgs: readonly any[]) => {
|
|
23
|
-
q: any;
|
|
24
|
-
requestId: any;
|
|
25
|
-
cannotAnswer: any;
|
|
26
|
-
analyticsMode: any;
|
|
27
|
-
actionCause: any;
|
|
28
|
-
};
|
|
29
|
-
memoizedResultFunc: ((...resultFuncArgs: readonly any[]) => {
|
|
30
|
-
q: any;
|
|
31
|
-
requestId: any;
|
|
32
|
-
cannotAnswer: any;
|
|
33
|
-
analyticsMode: any;
|
|
34
|
-
actionCause: any;
|
|
35
|
-
}) & {
|
|
36
|
-
clearCache: () => void;
|
|
37
|
-
resultsCount: () => number;
|
|
38
|
-
resetResultsCount: () => void;
|
|
39
|
-
};
|
|
40
|
-
lastResult: () => {
|
|
41
|
-
q: any;
|
|
42
|
-
requestId: any;
|
|
43
|
-
cannotAnswer: any;
|
|
44
|
-
analyticsMode: any;
|
|
45
|
-
actionCause: any;
|
|
46
|
-
};
|
|
47
|
-
dependencies: import("reselect").SelectorArray<any>;
|
|
48
|
-
recomputations: () => number;
|
|
49
|
-
resetRecomputations: () => void;
|
|
50
|
-
dependencyRecomputations: () => number;
|
|
51
|
-
resetDependencyRecomputations: () => void;
|
|
52
|
-
} & {
|
|
53
|
-
argsMemoize: typeof import("reselect").weakMapMemoize;
|
|
54
|
-
memoize: typeof import("reselect").weakMapMemoize;
|
|
55
|
-
};
|
|
56
|
-
export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
|
|
57
|
-
analytics?: {
|
|
58
|
-
actionCause?: string;
|
|
59
|
-
customData?: object;
|
|
60
|
-
clientId: string;
|
|
61
|
-
deviceId?: string;
|
|
62
|
-
pageId?: string;
|
|
63
|
-
clientTimestamp: string;
|
|
64
|
-
documentReferrer: string | null;
|
|
65
|
-
originContext: string;
|
|
66
|
-
userDisplayName?: string;
|
|
67
|
-
documentLocation?: string | null;
|
|
68
|
-
trackingId?: string;
|
|
69
|
-
capture?: boolean;
|
|
70
|
-
source?: string[];
|
|
71
|
-
};
|
|
72
|
-
tab: string;
|
|
73
|
-
numberOfResults?: number | undefined;
|
|
74
|
-
firstResult?: number | undefined;
|
|
75
|
-
queryCorrection?: {
|
|
76
|
-
enabled: boolean;
|
|
77
|
-
options: {
|
|
78
|
-
automaticallyCorrect: "never" | "whenNoResults";
|
|
79
|
-
};
|
|
80
|
-
} | undefined;
|
|
81
|
-
enableDidYouMean?: boolean | undefined;
|
|
82
|
-
fieldsToInclude?: string[] | undefined;
|
|
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;
|
|
84
|
-
pipeline?: string | undefined;
|
|
85
|
-
searchHub?: string | undefined;
|
|
86
|
-
pipelineRuleParameters: {
|
|
87
|
-
mlGenerativeQuestionAnswering: {
|
|
88
|
-
responseFormat: import("../../index.js").GeneratedResponseFormat;
|
|
89
|
-
citationsFieldToInclude: string[];
|
|
90
|
-
};
|
|
91
|
-
};
|
|
92
|
-
context?: import("../../ssr.index.js").ContextPayload | undefined;
|
|
93
|
-
enableQuerySyntax?: boolean | undefined;
|
|
94
|
-
lq?: string | undefined;
|
|
95
|
-
dq?: string | undefined;
|
|
96
|
-
cq?: string | undefined;
|
|
97
|
-
aq?: string | undefined;
|
|
98
|
-
q: string | undefined;
|
|
99
|
-
};
|
|
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) => ({
|
|
10
|
+
export declare const fetchAnswer: (fetchAnswerParams: Partial<SearchRequest>) => 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>;
|
|
11
|
+
export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
|
|
102
12
|
status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
|
|
103
13
|
originalArgs?: undefined | undefined;
|
|
104
14
|
data?: undefined | undefined;
|
|
@@ -11,9 +11,9 @@ export declare const buildGetCaseClassificationsRequest: (req: GetCaseClassifica
|
|
|
11
11
|
};
|
|
12
12
|
};
|
|
13
13
|
};
|
|
14
|
+
url: string;
|
|
15
|
+
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
14
16
|
accessToken: string;
|
|
15
17
|
method: import("../../../platform-client.js").HttpMethods;
|
|
16
18
|
contentType: import("../../../platform-client.js").HTTPContentType;
|
|
17
|
-
url: string;
|
|
18
|
-
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
19
19
|
};
|
|
@@ -28,9 +28,9 @@ export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSugges
|
|
|
28
28
|
source?: string[];
|
|
29
29
|
} | undefined;
|
|
30
30
|
};
|
|
31
|
+
url: string;
|
|
32
|
+
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
31
33
|
accessToken: string;
|
|
32
34
|
method: import("../../../platform-client.js").HttpMethods;
|
|
33
35
|
contentType: import("../../../platform-client.js").HTTPContentType;
|
|
34
|
-
url: string;
|
|
35
|
-
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
36
36
|
};
|
|
@@ -3,9 +3,9 @@ import { type InsightIdParam } from '../insight-params.js';
|
|
|
3
3
|
export type GetInsightInterfaceConfigRequest = BaseParam & InsightIdParam;
|
|
4
4
|
export declare const buildGetInsightInterfaceConfigRequest: (req: GetInsightInterfaceConfigRequest) => {
|
|
5
5
|
requestParams: {};
|
|
6
|
+
url: string;
|
|
7
|
+
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
6
8
|
accessToken: string;
|
|
7
9
|
method: import("../../../platform-client.js").HttpMethods;
|
|
8
10
|
contentType: import("../../../platform-client.js").HTTPContentType;
|
|
9
|
-
url: string;
|
|
10
|
-
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
11
11
|
};
|
|
@@ -8,18 +8,18 @@ interface CaseContextParam {
|
|
|
8
8
|
}
|
|
9
9
|
export declare const buildInsightQueryRequest: (req: InsightQueryRequest) => {
|
|
10
10
|
requestParams: {};
|
|
11
|
+
url: string;
|
|
12
|
+
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
11
13
|
accessToken: string;
|
|
12
14
|
method: import("../../../platform-client.js").HttpMethods;
|
|
13
15
|
contentType: import("../../../platform-client.js").HTTPContentType;
|
|
14
|
-
url: string;
|
|
15
|
-
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
16
16
|
};
|
|
17
17
|
export declare const buildInsightQuerySuggestRequest: (req: InsightQuerySuggestRequest) => {
|
|
18
18
|
requestParams: {};
|
|
19
|
+
url: string;
|
|
20
|
+
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
19
21
|
accessToken: string;
|
|
20
22
|
method: import("../../../platform-client.js").HttpMethods;
|
|
21
23
|
contentType: import("../../../platform-client.js").HTTPContentType;
|
|
22
|
-
url: string;
|
|
23
|
-
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
24
24
|
};
|
|
25
25
|
export {};
|
|
@@ -10,10 +10,10 @@ export declare const buildInsightUserActionsRequest: (req: InsightUserActionsReq
|
|
|
10
10
|
requestParams: {
|
|
11
11
|
objectId: string;
|
|
12
12
|
};
|
|
13
|
+
url: string;
|
|
14
|
+
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
13
15
|
accessToken: string;
|
|
14
16
|
method: import("../../../platform-client.js").HttpMethods;
|
|
15
17
|
contentType: import("../../../platform-client.js").HTTPContentType;
|
|
16
|
-
url: string;
|
|
17
|
-
origin: import("../../../preprocess-request.js").PlatformClientOrigin;
|
|
18
18
|
};
|
|
19
19
|
export {};
|