@coveo/quantic 3.21.1 → 3.21.2-pre.4f62235e2d

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

@@ -1,4 +1,5 @@
 import { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
+import { NavigatorContext } from '../../app/navigator-context-provider.js';
 import { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
 import { SearchAppState } from '../../state/search-app-state.js';
 import { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection, TabSection } from '../../state/state-sections.js';
@@ -60,7 +61,22 @@ 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") => {
+export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
+    analytics?: {
+        actionCause?: string;
+        customData?: object;
+        clientId: string;
+        deviceId?: string;
+        pageId?: string;
+        clientTimestamp: string;
+        documentReferrer: string | null;
+        originContext: string;
+        userDisplayName?: string;
+        documentLocation?: string | null;
+        trackingId?: string;
+        capture?: boolean;
+        source?: string[];
+    };
     tab: string;
     numberOfResults?: number | undefined;
     firstResult?: number | undefined;
@@ -87,8 +103,8 @@ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI,
     aq?: string | undefined;
     q: string | undefined;
 };
-export declare const fetchAnswer: (state: StateNeededByAnswerAPI) => 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) => ({
+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) => ({
     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

@@ -2,6 +2,10 @@ import { 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;
 export declare const expectedStreamAnswerAPIParam: {
     q: string;
     aq: string;
@@ -111,6 +115,15 @@ export declare const expectedStreamAnswerAPIParam: {
     numberOfResults: number;
     firstResult: number;
     tab: string;
+    analytics: {
+        capture: boolean;
+        clientId: string;
+        clientTimestamp: string;
+        documentLocation: string;
+        documentReferrer: string;
+        originContext: string;
+        source: string[];
+    };
 };
 export declare const expectedStreamAnswerAPIParamWithATabWithAnExpression: {
     cq: string;
@@ -221,6 +234,15 @@ export declare const expectedStreamAnswerAPIParamWithATabWithAnExpression: {
     enableDidYouMean: boolean;
     numberOfResults: number;
     firstResult: number;
+    analytics: {
+        capture: boolean;
+        clientId: string;
+        clientTimestamp: string;
+        documentLocation: string;
+        documentReferrer: string;
+        originContext: string;
+        source: string[];
+    };
 };
 export declare const expectedStreamAnswerAPIParamWithoutAnyTab: {
     tab: string;
@@ -331,4 +353,251 @@ export declare const expectedStreamAnswerAPIParamWithoutAnyTab: {
     enableDidYouMean: boolean;
     numberOfResults: number;
     firstResult: number;
+    analytics: {
+        capture: boolean;
+        clientId: string;
+        clientTimestamp: string;
+        documentLocation: string;
+        documentReferrer: string;
+        originContext: string;
+        source: string[];
+    };
+};
+export declare const expectedStreamAnswerAPIParamWithStaticFiltersSelected: {
+    cq: string;
+    q: string;
+    aq: string;
+    dq: string;
+    lq: string;
+    pipelineRuleParameters: {
+        mlGenerativeQuestionAnswering: {
+            responseFormat: {
+                contentFormat: string[];
+            };
+            citationsFieldToInclude: never[];
+        };
+    };
+    searchHub: string;
+    facets: ({
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        resultsMustMatch: string;
+        type: string;
+        currentValues: never[];
+        freezeCurrentValues: boolean;
+        isFieldExpanded: boolean;
+        preventAutoSelect: boolean;
+        facetId: string;
+        field: string;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            start: string;
+            end: string;
+            endInclusive: boolean;
+            state: string;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        delimitingCharacter: string;
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        basePath: never[];
+        filterByBasePath: boolean;
+        resultsMustMatch: string;
+        currentValues: never[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            endInclusive: boolean;
+            state: string;
+            start: number;
+            end: number;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    })[];
+    fieldsToInclude: string[];
+    queryCorrection: {
+        enabled: boolean;
+        options: {
+            automaticallyCorrect: string;
+        };
+    };
+    enableDidYouMean: boolean;
+    numberOfResults: number;
+    firstResult: number;
+    tab: string;
+    analytics: {
+        capture: boolean;
+        clientId: string;
+        clientTimestamp: string;
+        documentLocation: string;
+        documentReferrer: string;
+        originContext: string;
+        source: string[];
+    };
+};
+export declare const expectedStreamAnswerAPIParamWithStaticFiltersAndTabExpression: {
+    cq: string;
+    q: string;
+    aq: string;
+    dq: string;
+    lq: string;
+    pipelineRuleParameters: {
+        mlGenerativeQuestionAnswering: {
+            responseFormat: {
+                contentFormat: string[];
+            };
+            citationsFieldToInclude: never[];
+        };
+    };
+    searchHub: string;
+    facets: ({
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        resultsMustMatch: string;
+        type: string;
+        currentValues: never[];
+        freezeCurrentValues: boolean;
+        isFieldExpanded: boolean;
+        preventAutoSelect: boolean;
+        facetId: string;
+        field: string;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            start: string;
+            end: string;
+            endInclusive: boolean;
+            state: string;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        delimitingCharacter: string;
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        basePath: never[];
+        filterByBasePath: boolean;
+        resultsMustMatch: string;
+        currentValues: never[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            endInclusive: boolean;
+            state: string;
+            start: number;
+            end: number;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    })[];
+    fieldsToInclude: string[];
+    queryCorrection: {
+        enabled: boolean;
+        options: {
+            automaticallyCorrect: string;
+        };
+    };
+    enableDidYouMean: boolean;
+    numberOfResults: number;
+    firstResult: number;
+    tab: string;
+    analytics: {
+        capture: boolean;
+        clientId: string;
+        clientTimestamp: string;
+        documentLocation: string;
+        documentReferrer: string;
+        originContext: string;
+        source: string[];
+    };
 };

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

@@ -17,7 +17,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
     facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
+    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

@@ -18,7 +18,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
     facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: import("../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
+    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/static-filter-set/static-filter-set-selectors.d.ts

@@ -0,0 +1,27 @@
+import { StaticFilterSection } from '../../state/state-sections.js';
+/**
+ * Given a static filter state, returns an array of selected filter expressions.
+ * @param state The static filter state that contains the static filter set.
+ * @returns An array of filter expressions.
+ */
+export declare const selectStaticFilterExpressions: ((state: Partial<StaticFilterSection>) => string[]) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: import("./static-filter-set-state.js").StaticFilterSetState | undefined) => string[];
+    memoizedResultFunc: ((resultFuncArgs_0: import("./static-filter-set-state.js").StaticFilterSetState | undefined) => string[]) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => string[];
+    dependencies: [(state: Partial<StaticFilterSection>) => import("./static-filter-set-state.js").StaticFilterSetState | undefined];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};