@coveo/quantic 3.29.3 → 3.29.4-pre.059141fc23

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/search-analytics.d.ts

@@ -90,13 +90,15 @@ export declare class SearchAnalyticsProvider extends BaseAnalyticsProvider<State
     protected get responseTime(): number;
     protected get numberOfResults(): number;
 }
-interface LegacyConfigureAnalyticsOptions {
+interface LegacyConfigureAnalyticsOptions<State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> {
     logger: Logger;
     analyticsClientMiddleware?: AnalyticsClientSendEventHook;
     preprocessRequest?: PreprocessRequest;
     provider?: SearchPageClientProvider;
-    getState(): StateNeededBySearchAnalyticsProvider;
+    getState(): State;
 }
-export declare const configureLegacyAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions) => CoveoSearchPageClient;
+export declare const configureLegacyAnalytics: <State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider>({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions<State> & {
+    provider: SearchPageClientProvider;
+}) => CoveoSearchPageClient;
 export declare const getPageID: () => string;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/product.d.ts

@@ -130,6 +130,10 @@ export interface BaseProduct {
      * The length and offset of each word to highlight in the product excerpt string.
      */
     excerptsHighlights?: HighlightKeyword[];
+    /**
+     * The ID of the response that returned the product.
+     */
+    responseId?: string;
 }
 export interface Product extends BaseProduct {
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/generated-answer-stream.d.ts

@@ -0,0 +1,15 @@
+import type { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
+import type { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
+export interface GeneratedAnswerStream {
+    answerId?: string;
+    contentFormat?: GeneratedContentFormat;
+    answer?: string;
+    citations?: GeneratedAnswerCitation[];
+    generated?: boolean;
+    isStreaming: boolean;
+    isLoading: boolean;
+    error?: {
+        message: string;
+        code: number;
+    };
+}

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-actions.d.ts

@@ -1,7 +1,7 @@
 import type { NavigatorContext } from '../../app/navigator-context-provider.js';
-import { type StateNeededByAnswerAPI } from './stream-answer-api.js';
+import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
 export declare const triggerSearchRequest: import("@reduxjs/toolkit").AsyncThunk<void, {
-    state: StateNeededByAnswerAPI;
+    state: StreamAnswerAPIState;
     navigatorContext: NavigatorContext;
 }, {
     state?: unknown;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api-state.d.ts

@@ -0,0 +1,6 @@
+import type { SearchAppState } from '../../state/search-app-state.js';
+import type { ConfigurationSection, GeneratedAnswerSection, GetAnswerQuerySection, InsightConfigurationSection, TabSection } from '../../state/state-sections.js';
+export type StreamAnswerAPIState = {
+    searchHub: string;
+    pipeline: string;
+} & GetAnswerQuerySection & ConfigurationSection & Partial<SearchAppState> & Partial<InsightConfigurationSection> & GeneratedAnswerSection & Partial<TabSection>;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts

@@ -1,30 +1,10 @@
 import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
 import { type NavigatorContext } from '../../app/navigator-context-provider.js';
-import type { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
-import type { SearchAppState } from '../../state/search-app-state.js';
-import type { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection, TabSection } from '../../state/state-sections.js';
 import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
-import type { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
 import type { SearchRequest } from '../search/search/search-request.js';
-export type StateNeededByAnswerAPI = {
-    searchHub: string;
-    pipeline: string;
-    answer: ReturnType<typeof answerApi.reducer>;
-} & ConfigurationSection & Partial<SearchAppState> & Partial<InsightConfigurationSection> & GeneratedAnswerSection & Partial<TabSection>;
-export interface GeneratedAnswerStream {
-    answerId?: string;
-    contentFormat?: GeneratedContentFormat;
-    answer?: string;
-    citations?: GeneratedAnswerCitation[];
-    generated?: boolean;
-    isStreaming: boolean;
-    isLoading: boolean;
-    error?: {
-        message: string;
-        code: number;
-    };
-}
-export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StateNeededByAnswerAPI, unknown, UnknownAction>) => void;
+import type { GeneratedAnswerStream } from './generated-answer-stream.js';
+import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
+export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction>) => void;
 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, {}>, {
     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">;
 }, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
@@ -73,7 +53,7 @@ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[])
     argsMemoize: typeof import("reselect").weakMapMemoize;
     memoize: typeof import("reselect").weakMapMemoize;
 };
-export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
+export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
     analytics?: {
         actionCause?: string;
         customData?: object;
@@ -100,12 +80,12 @@ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI,
     } | undefined;
     enableDidYouMean?: boolean | undefined;
     fieldsToInclude?: string[] | undefined;
-    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/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
+    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;
     pipeline?: string | undefined;
     searchHub?: string | undefined;
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
-            responseFormat: import("../../features/generated-answer/generated-response-format.js").GeneratedResponseFormat;
+            responseFormat: import("../../index.js").GeneratedResponseFormat;
             citationsFieldToInclude: string[];
         };
     };
@@ -117,8 +97,8 @@ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI,
     aq?: string | undefined;
     q: string | undefined;
 };
-export declare const fetchAnswer: (state: StateNeededByAnswerAPI, 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>;
-export declare const selectAnswer: (state: StateNeededByAnswerAPI, navigatorContext?: NavigatorContext) => ({
+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>;
+export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContext?: NavigatorContext) => ({
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
     originalArgs?: undefined | undefined;
     data?: undefined | undefined;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts

@@ -1,12 +1,12 @@
 /** biome-ignore-all lint/suspicious/noExplicitAny: <mock> */
-import type { StateNeededByAnswerAPI } from '../stream-answer-api.js';
-export declare const streamAnswerAPIStateMock: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithoutAnyTab: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithNonValidFilters: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithoutAnyFilters: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StateNeededByAnswerAPI;
+import type { StreamAnswerAPIState } from '../stream-answer-api-state.js';
+export declare const streamAnswerAPIStateMock: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithoutAnyTab: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithNonValidFilters: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithoutAnyFilters: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StreamAnswerAPIState;
 export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWithEmptyCQ: {
     advancedSearchQueries: {
         cq: string;
@@ -26,9 +26,9 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
     };
     searchHub: string;
     pipeline: string;
-    answer: ReturnType<import("redux").Reducer<import("@reduxjs/toolkit/query").CombinedState<{
-        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("../stream-answer-api.js").GeneratedAnswerStream, "answer">;
-    }, never, "answer">, import("redux").UnknownAction>>;
+    answer: import("@reduxjs/toolkit/query").CombinedState<{
+        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">;
+    }, never, "answer">;
     configuration: import("../../../features/configuration/configuration-state.js").ConfigurationState;
     facetSet?: import("../../../features/facets/facet-set/facet-set-state.js").FacetSetState | undefined;
     dateFacetSet?: import("../../../features/facets/range-facets/date-facet-set/date-facet-set-state.js").DateFacetSetState | undefined;
@@ -66,7 +66,7 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
     instantResults?: import("../../../features/instant-results/instant-results-state.js").InstantResultsState | undefined;
     insightConfiguration?: import("../../../features/insight-configuration/insight-configuration-state.js").InsightConfigurationState | undefined;
 };
-export declare const streamAnswerAPIStateMockWithoutSearchAction: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithoutSearchAction: StreamAnswerAPIState;
 export declare const expectedStreamAnswerAPIParam: {
     q: string;
     aq: string;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/date-range.d.ts

@@ -5,11 +5,11 @@ import type { DateRangeRequest } from '../../../../../features/facets/range-face
 export type DateRangeInput = AbsoluteDate | RelativeDate;
 export interface DateRangeOptions {
     /**
-     * The starting value for the date range. A date range can be either absolute or [relative](https://docs.coveo.com/en/headless/latest/reference/search/controllers/date-facet/relative-date-format/).
+     * The starting value for the date range. A date range can be either absolute or [relative](https://docs.coveo.com/en/headless/latest/reference/documents/Search.DateFacet.relative-date-format.html).
      */
     start: DateRangeInput;
     /**
-     * The ending value for the date range. A date range can be either absolute or [relative](https://docs.coveo.com/en/headless/latest/reference/search/controllers/date-facet/relative-date-format/).
+     * The ending value for the date range. A date range can be either absolute or [relative](https://docs.coveo.com/en/headless/latest/reference/documents/Search.DateFacet.relative-date-format.html).
      */
     end: DateRangeInput;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/interfaces/request.d.ts

@@ -7,11 +7,11 @@ import type { BaseRangeFacetRequest } from '../../generic/interfaces/request.js'
  */
 export interface DateRangeRequest {
     /**
-     * The starting value for the date range, formatted as `YYYY/MM/DD@HH:mm:ss` or the [Relative Date](https://docs.coveo.com/en/headless/latest/reference/search/controllers/date-facet/relative-date-format/) format "period-amount-unit".
+     * The starting value for the date range, formatted as `YYYY/MM/DD@HH:mm:ss` or the [Relative Date](https://docs.coveo.com/en/headless/latest/reference/documents/Search.DateFacet.relative-date-format.html) format "period-amount-unit".
      */
     start: string;
     /**
-     * The ending value for the date range, formatted as `YYYY/MM/DD@HH:mm:ss` or the [Relative Date](https://docs.coveo.com/en/headless/latest/reference/search/controllers/date-facet/relative-date-format/) format "period-amount-unit".
+     * The ending value for the date range, formatted as `YYYY/MM/DD@HH:mm:ss` or the [Relative Date](https://docs.coveo.com/en/headless/latest/reference/documents/Search.DateFacet.relative-date-format.html) format "period-amount-unit".
      */
     end: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-selectors.d.ts

@@ -1,10 +1,7 @@
 import type { GeneratedAnswerCitation } from '../../controllers/generated-answer/headless-generated-answer.js';
 import type { SearchAppState } from '../../state/search-app-state.js';
 import type { GeneratedAnswerSection } from '../../state/state-sections.js';
-export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => {
-    answerAPIEnabled: boolean;
-    id: string | undefined;
-};
+export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => string | undefined;
 export declare const selectFieldsToIncludeInCitation: (state: Partial<GeneratedAnswerSection>) => string[] | undefined;
 export declare const citationSourceSelector: ((state: Partial<GeneratedAnswerSection>, citationId: string) => GeneratedAnswerCitation | undefined) & {
     clearCache: () => void;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts

@@ -24,7 +24,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
     facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
+    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;
     cq?: string;
     queryCorrection?: {
         enabled?: boolean;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts

@@ -25,7 +25,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
     facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
+    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;
     cq?: string;
     queryCorrection?: {
         enabled?: boolean;

package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts

@@ -1,3 +1,6 @@
+import type { BaseQueryFn, CombinedState, FetchArgs, FetchBaseQueryError, QueryDefinition, RetryOptions } from '@reduxjs/toolkit/query';
+import type { GeneratedAnswerStream } from '../api/knowledge/generated-answer-stream.js';
+import type { SearchRequest } from '../api/search/search/search-request.js';
 import type { StateWithHistory } from '../app/undoable.js';
 import type { AdvancedSearchQueriesState } from '../features/advanced-search-queries/advanced-search-queries-state.js';
 import type { AttachedResultsState } from '../features/attached-results/attached-results-state.js';
@@ -438,3 +441,8 @@ export interface InsightUserActionsSection {
 export interface ManualRangeSection {
     manualNumericFacetSet: ManualNumericFacetSetState;
 }
+export interface GetAnswerQuerySection {
+    answer: CombinedState<{
+        getAnswer: QueryDefinition<Partial<SearchRequest>, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {} & RetryOptions, {}>, never, GeneratedAnswerStream, 'answer'>;
+    }, never, 'answer'>;
+}

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/facet-utils.d.ts

@@ -9,5 +9,5 @@ export declare function sortFacets<T extends {
     facetId: string;
 }>(facets: T[], sortOrder: string[]): T[];
 export declare const sortCriteriaMap: Record<string, SortCriteria>;
-export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[];
+export declare function getFacets(state: StateNeededBySearchRequest): (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)[];
 export {};