@coveo/quantic 3.29.5-pre.cefa2bd755 → 3.29.5-pre.d80db02f3e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -8
  2. package/force-app/main/default/staticresources/coveoheadless/definitions/api/api-client-utils.d.ts +1 -1
  3. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +2 -2
  4. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +2 -2
  5. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +2 -2
  6. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +93 -3
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts +1051 -0
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +2 -2
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +2 -2
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts +2 -2
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts +4 -4
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts +2 -2
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +0 -2
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts +0 -2005
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-state.d.ts +0 -5
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +0 -3
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/fetch-static-state.d.ts +4 -0
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/build.d.ts +3 -0
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/engine.d.ts +3 -0
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts +3 -3
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/build-factory.d.ts +4 -3
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/hydrated-state-factory.d.ts +1 -1
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-hydrated-state-factory.d.ts +1 -1
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts +2 -1
  25. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts +2 -1
  26. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/build.d.ts +38 -7
  27. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/controller-definitions.d.ts +40 -2
  28. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts +15 -8
  29. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/fetch-static-state.d.ts +3 -3
  30. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/utilities.d.ts +6 -0
  31. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/utils/controller-wiring.d.ts +8 -0
  32. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/utils/engine-wiring.d.ts +5 -0
  33. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/validation/controller-validation.d.ts +1 -0
  34. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/types/fetch-static-state.d.ts +1 -3
  35. package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -10
  36. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -9
  37. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
  38. package/package.json +2 -2
  39. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer-mocks.d.ts +0 -1997
  40. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/utils/testingUtils.d.ts +0 -8
  41. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/answer-api-selectors.d.ts +0 -74
@@ -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, "url" | "accessToken" | "organizationId" | "authentication">;
6
+ export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "accessToken" | "url" | "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;
33
31
  accessToken: string;
34
32
  method: import("../../platform-client.js").HttpMethods;
35
33
  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;
29
27
  accessToken: string;
30
28
  method: import("../../platform-client.js").HttpMethods;
31
29
  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;
26
24
  accessToken: string;
27
25
  method: import("../../../platform-client.js").HttpMethods;
28
26
  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,4 +1,5 @@
1
- import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
1
+ import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
2
+ import { type NavigatorContext } from '../../app/navigator-context-provider.js';
2
3
  import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
3
4
  import type { SearchRequest } from '../search/search/search-request.js';
4
5
  import type { GeneratedAnswerStream } from './generated-answer-stream.js';
@@ -7,8 +8,97 @@ export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: Ge
7
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, {}>, {
8
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">;
9
10
  }, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
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) => ({
11
+ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[]) => {
12
+ q: any;
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) => ({
12
102
  status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
13
103
  originalArgs?: undefined | undefined;
14
104
  data?: undefined | undefined;