@coveo/quantic 3.30.0 → 3.30.1-pre.0b6ca95bda

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 (28) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +10 -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 +3 -93
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +2 -2
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +2 -2
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts +2 -2
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts +4 -4
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts +2 -2
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer-mocks.d.ts +2003 -0
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/utils/testingUtils.d.ts +8 -0
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-actions-loader.d.ts +14 -1
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-actions.d.ts +2 -9
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-analytics-actions-loader.d.ts +35 -0
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/answer-api-selectors.d.ts +72 -0
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +2 -0
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts +2005 -0
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-state.d.ts +5 -0
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +2 -0
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +1 -0
  23. package/force-app/main/default/staticresources/coveoheadless/headless.js +12 -10
  24. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +11 -9
  25. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +9 -7
  26. package/package.json +4 -3
  27. package/docs/out/quantic-docs.json +0 -6440
  28. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts +0 -1051
@@ -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, "accessToken" | "organizationId" | "url" | "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;
@@ -29,10 +29,10 @@ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path
29
29
  sort: import("./sort.js").SortOption | undefined;
30
30
  };
31
31
  accessToken: string;
32
- url: string;
33
32
  method: import("../../platform-client.js").HttpMethods;
34
- origin: import("../../preprocess-request.js").PlatformClientOrigin;
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">;
@@ -25,9 +25,9 @@ export declare const buildRecommendationsRequest: (req: CommerceRecommendationsR
25
25
  perPage: number | undefined;
26
26
  };
27
27
  accessToken: string;
28
- url: string;
29
28
  method: import("../../platform-client.js").HttpMethods;
30
- origin: import("../../preprocess-request.js").PlatformClientOrigin;
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
  };
@@ -22,9 +22,9 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
22
22
  currency: string;
23
23
  };
24
24
  accessToken: string;
25
- url: string;
26
25
  method: import("../../../platform-client.js").HttpMethods;
27
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
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,5 +1,4 @@
1
- import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
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 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: "whenNoResults" | "never";
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;
@@ -12,8 +12,8 @@ export declare const buildGetCaseClassificationsRequest: (req: GetCaseClassifica
12
12
  };
13
13
  };
14
14
  accessToken: string;
15
- url: string;
16
15
  method: import("../../../platform-client.js").HttpMethods;
17
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
18
16
  contentType: import("../../../platform-client.js").HTTPContentType;
17
+ url: string;
18
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
19
19
  };
@@ -29,8 +29,8 @@ export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSugges
29
29
  } | undefined;
30
30
  };
31
31
  accessToken: string;
32
- url: string;
33
32
  method: import("../../../platform-client.js").HttpMethods;
34
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
35
33
  contentType: import("../../../platform-client.js").HTTPContentType;
34
+ url: string;
35
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
36
36
  };
@@ -4,8 +4,8 @@ export type GetInsightInterfaceConfigRequest = BaseParam & InsightIdParam;
4
4
  export declare const buildGetInsightInterfaceConfigRequest: (req: GetInsightInterfaceConfigRequest) => {
5
5
  requestParams: {};
6
6
  accessToken: string;
7
- url: string;
8
7
  method: import("../../../platform-client.js").HttpMethods;
9
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
10
8
  contentType: import("../../../platform-client.js").HTTPContentType;
9
+ url: string;
10
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
11
11
  };
@@ -9,17 +9,17 @@ interface CaseContextParam {
9
9
  export declare const buildInsightQueryRequest: (req: InsightQueryRequest) => {
10
10
  requestParams: {};
11
11
  accessToken: string;
12
- url: string;
13
12
  method: import("../../../platform-client.js").HttpMethods;
14
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
15
13
  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
19
  accessToken: string;
20
- url: string;
21
20
  method: import("../../../platform-client.js").HttpMethods;
22
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
23
21
  contentType: import("../../../platform-client.js").HTTPContentType;
22
+ url: string;
23
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
24
24
  };
25
25
  export {};
@@ -11,9 +11,9 @@ export declare const buildInsightUserActionsRequest: (req: InsightUserActionsReq
11
11
  objectId: string;
12
12
  };
13
13
  accessToken: string;
14
- url: string;
15
14
  method: import("../../../platform-client.js").HttpMethods;
16
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
17
15
  contentType: import("../../../platform-client.js").HTTPContentType;
16
+ url: string;
17
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
18
18
  };
19
19
  export {};