@coveo/quantic 3.36.3 → 3.36.5

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-search-set/category/commerce-category-facet-search-set-slice.d.ts

@@ -0,0 +1,3 @@
+export declare const commerceCategoryFacetSearchSetReducer: import("@reduxjs/toolkit").Reducer<import("../../../../facets/facet-search-set/category/category-facet-search-set-state.js").CategoryFacetSearchSetState> & {
+    getInitialState: () => import("../../../../facets/facet-search-set/category/category-facet-search-set-state.js").CategoryFacetSearchSetState;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-search-set/commerce-facet-search-reducer-helpers.d.ts

@@ -0,0 +1,23 @@
+import type { CommerceAPIResponse } from '../../../../api/commerce/commerce-api-client.js';
+import type { FacetSearchResponse } from '../../../../api/search/facet-search/facet-search-response.js';
+import { type FacetSearchSetState } from '../../../facets/facet-search-set/facet-search-reducer-helpers.js';
+import type { FieldSuggestionsFacet } from '../field-suggestions-order/field-suggestions-order-state.js';
+export declare function handleCommerceFacetSearchFulfilled<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: {
+    facetId: string;
+    response: CommerceAPIResponse<T>;
+}, requestId: string): void;
+export declare function handleCommerceFacetFieldSuggestionsFulfilled<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: {
+    facetId: string;
+    response: CommerceAPIResponse<T>;
+}, requestId: string, buildEmptyResponse: () => T): void;
+export declare function handleCommerceFetchQuerySuggestionsFulfilledForRegularFacet<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: {
+    fieldSuggestionsFacets: {
+        facetId: string;
+        type: string;
+    }[];
+    query: string | undefined;
+}, requestId: string, buildEmptyResponse: () => T): void;
+export declare function handleCommerceFetchQuerySuggestionsFulfilledForCategoryFacet<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: {
+    fieldSuggestionsFacets: FieldSuggestionsFacet[];
+    query: string | undefined;
+}, requestId: string, buildEmptyResponse: () => T): void;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-search-set/regular/commerce-specific-facet-search-set-slice.d.ts

@@ -0,0 +1,3 @@
+export declare const commerceSpecificFacetSearchSetReducer: import("@reduxjs/toolkit").Reducer<import("../../../../facets/facet-search-set/specific/specific-facet-search-set-state.js").SpecificFacetSearchSetState> & {
+    getInitialState: () => import("../../../../facets/facet-search-set/specific/specific-facet-search-set-state.js").SpecificFacetSearchSetState;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query-set/commerce-query-set-slice.d.ts

@@ -0,0 +1,4 @@
+import { type QuerySetState } from '../../query-set/query-set-state.js';
+export declare const commerceQuerySetReducer: import("@reduxjs/toolkit").Reducer<QuerySetState> & {
+    getInitialState: () => QuerySetState;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query-suggest/commerce-query-suggest-slice.d.ts

@@ -0,0 +1,3 @@
+export declare const commerceQuerySuggestReducer: import("@reduxjs/toolkit").Reducer<import("../../query-suggest/query-suggest-state.js").QuerySuggestSet> & {
+    getInitialState: () => import("../../query-suggest/query-suggest-state.js").QuerySuggestSet;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/plan-request-builder.d.ts

@@ -1,9 +1,6 @@
-import type { PageParam, PerPageParam, QueryParam } from '../../../api/commerce/commerce-api-params.js';
-import type { BaseCommerceAPIRequest } from '../../../api/commerce/common/request.js';
+import type { CommercePlanRequest } from '../../../api/commerce/search/plan/plan-request.js';
 import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
 import type { CommerceQuerySection } from '../../../state/state-sections.js';
 import { type StateNeededForBaseCommerceAPIRequest } from '../common/base-commerce-api-request-builder.js';
 export type StateNeededForPlanCommerceAPIRequest = StateNeededForBaseCommerceAPIRequest & CommerceQuerySection;
-type CommercePlanRequest = BaseCommerceAPIRequest & QueryParam & PageParam & PerPageParam;
 export declare const buildPlanRequest: (state: StateNeededForPlanCommerceAPIRequest, navigatorContext: NavigatorContext) => CommercePlanRequest;
-export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-set-state.d.ts

@@ -2,6 +2,10 @@ import type { CategoryFacetRequest } from './interfaces/request.js';
 export type CategoryFacetSlice = {
     request: CategoryFacetRequest;
     initialNumberOfValues: number;
+    tabs?: {
+        included?: string[];
+        excluded?: string[];
+    };
 };
 export type CategoryFacetSetState = Record<string, CategoryFacetSlice>;
 export declare function getCategoryFacetSetInitialState(): CategoryFacetSetState;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-search-set/facet-search-reducer-helpers.d.ts

@@ -1,7 +1,5 @@
-import type { CommerceAPIResponse } from '../../../api/commerce/commerce-api-client.js';
 import type { FacetSearchRequestOptions } from '../../../api/search/facet-search/base/base-facet-search-request.js';
 import type { FacetSearchResponse } from '../../../api/search/facet-search/facet-search-response.js';
-import type { FieldSuggestionsFacet } from '../../commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
 import type { FacetSearchOptions } from './facet-search-request-options.js';
 export type FacetSearchState<T extends FacetSearchResponse> = {
     /**
@@ -33,25 +31,6 @@ export declare function handleFacetSearchFulfilled<T extends FacetSearchResponse
     facetId: string;
     response: T;
 }, requestId: string): void;
-export declare function handleCommerceFacetSearchFulfilled<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: {
-    facetId: string;
-    response: CommerceAPIResponse<T>;
-}, requestId: string): void;
-export declare function handleCommerceFacetFieldSuggestionsFulfilled<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: {
-    facetId: string;
-    response: CommerceAPIResponse<T>;
-}, requestId: string, buildEmptyResponse: () => T): void;
-export declare function handleCommerceFetchQuerySuggestionsFulfilledForRegularFacet<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: {
-    fieldSuggestionsFacets: {
-        facetId: string;
-        type: string;
-    }[];
-    query: string | undefined;
-}, requestId: string, buildEmptyResponse: () => T): void;
-export declare function handleCommerceFetchQuerySuggestionsFulfilledForCategoryFacet<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: {
-    fieldSuggestionsFacets: FieldSuggestionsFacet[];
-    query: string | undefined;
-}, requestId: string, buildEmptyResponse: () => T): void;
 export declare function handleFacetSearchClear<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, payload: FacetSearchOptions, buildEmptyResponse: () => T): void;
 export declare function handleFacetSearchSetClear<T extends FacetSearchResponse>(state: FacetSearchSetState<T>, buildEmptyResponse: () => T): void;
 export declare const defaultFacetSearchOptions: FacetSearchRequestOptions;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-state.d.ts

@@ -2,10 +2,17 @@ import type { FacetRequest } from './interfaces/request.js';
 export type FacetSlice = {
     request: FacetRequest;
     hasBreadcrumbs: boolean;
+    tabs?: {
+        included?: string[];
+        excluded?: string[];
+    };
 };
 /**
  * A map of specific facet identifier (typically, the facet field) to a facet request
  */
 export type FacetSetState = Record<string, FacetSlice>;
-export declare function getFacetSetSliceInitialState(request: FacetRequest): FacetSlice;
+export declare function getFacetSetSliceInitialState(request: FacetRequest, tabs?: {
+    included?: string[];
+    excluded?: string[];
+}): FacetSlice;
 export declare function getFacetSetInitialState(): FacetSetState;

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

@@ -1,7 +1,14 @@
 import type { DateFacetRequest } from './interfaces/request.js';
 export type DateFacetSlice = {
     request: DateFacetRequest;
+    tabs?: {
+        included?: string[];
+        excluded?: string[];
+    };
 };
 export type DateFacetSetState = Record<string, DateFacetSlice>;
-export declare function getDateFacetSetSliceInitialState(request: DateFacetRequest): DateFacetSlice;
+export declare function getDateFacetSetSliceInitialState(request: DateFacetRequest, tabs?: {
+    included?: string[];
+    excluded?: string[];
+}): DateFacetSlice;
 export declare function getDateFacetSetInitialState(): DateFacetSetState;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/numeric-facet-set-state.d.ts

@@ -1,7 +1,14 @@
 import type { NumericFacetRequest } from './interfaces/request.js';
 export type NumericFacetSlice = {
     request: NumericFacetRequest;
+    tabs?: {
+        included?: string[];
+        excluded?: string[];
+    };
 };
 export type NumericFacetSetState = Record<string, NumericFacetSlice>;
-export declare function getNumericFacetSetSliceInitialState(request: NumericFacetRequest): NumericFacetSlice;
+export declare function getNumericFacetSetSliceInitialState(request: NumericFacetRequest, tabs?: {
+    included?: string[];
+    excluded?: string[];
+}): NumericFacetSlice;
 export declare function getNumericFacetSetInitialState(): NumericFacetSetState;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answer-request.d.ts

@@ -0,0 +1,4 @@
+import type { FollowUpAnswerParams } from '../../api/knowledge/answer-generation/endpoints/follow-up/follow-up-endpoint.js';
+import type { ConfigurationSection, FollowUpAnswersSection } from '../../state/state-sections.js';
+export type StateNeededForFollowUpAnswerParams = FollowUpAnswersSection & ConfigurationSection;
+export declare const constructGenerateFollowUpAnswerParams: (followUpQuestion: string, state: StateNeededForFollowUpAnswerParams) => FollowUpAnswerParams;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answers-actions.d.ts

@@ -1,5 +1,7 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
+import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
 import type { GeneratedContentFormat } from '../generated-answer/generated-response-format.js';
+import { type StateNeededForFollowUpAnswerParams } from './follow-up-answer-request.js';
 export declare const setIsEnabled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "followUpAnswers/setIsEnabled", never, never>;
 export declare const setFollowUpAnswersConversationId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "followUpAnswers/setFollowUpAnswersConversationId", never, never>;
 export declare const createFollowUpAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
@@ -68,3 +70,13 @@ export declare const submitFollowUpFeedback: import("@reduxjs/toolkit").ActionCr
     answerId: string;
 }, "followUpAnswers/submitFollowUpFeedback", never, never>;
 export declare const resetFollowUpAnswers: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"followUpAnswers/resetFollowUpAnswers">;
+export declare const generateFollowUpAnswer: import("@reduxjs/toolkit").AsyncThunk<void, string, {
+    state: StateNeededForFollowUpAnswerParams;
+    extra: SearchThunkExtraArguments;
+    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;

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

@@ -44,10 +44,7 @@ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[])
     memoize: typeof import("reselect").weakMapMemoize;
 };
 /**
- * If answer params are not available, returns `skipToken`, a special value from RTK Query
- * that tells RTK Query to "skip" running a query or selector until the params are ready.
- *
- * @see https://redux-toolkit.js.org/rtk-query/usage-with-typescript#skipping-queries-with-typescript-using-skiptoken
+ * Selects the parameters to be used in the Answer API request.
  */
 export declare const selectAnswerApiQueryParams: ((state: any, ...params: any[]) => any) & {
     clearCache: () => void;

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

@@ -1,7 +1,9 @@
+import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
 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>) => string | undefined;
+export declare const isGeneratedAnswerFeatureEnabledWithAnswerGenerationAPI: (state: Partial<SearchAppState>) => state is StreamAnswerAPIState;
 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/query-suggest/query-suggest-reducer-helpers.d.ts

@@ -0,0 +1,7 @@
+import type { AnyAction, Draft as WritableDraft } from '@reduxjs/toolkit';
+import type { ClearQuerySuggestActionCreatorPayload, RegisterQuerySuggestActionCreatorPayload } from './query-suggest-actions.js';
+import type { QuerySuggestSet } from './query-suggest-state.js';
+export declare function handleRegisterQuerySuggest(state: WritableDraft<QuerySuggestSet>, payload: RegisterQuerySuggestActionCreatorPayload): void;
+export declare function handleFetchPending(state: WritableDraft<QuerySuggestSet>, action: AnyAction): void;
+export declare function handleFetchRejected(state: WritableDraft<QuerySuggestSet>, action: AnyAction): void;
+export declare function handleClearQuerySuggest(state: WritableDraft<QuerySuggestSet>, payload: ClearQuerySuggestActionCreatorPayload): void;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/query-suggest/query-suggest-slice.d.ts

@@ -1,4 +1,3 @@
-import { type QuerySuggestSet } from './query-suggest-state.js';
-export declare const querySuggestReducer: import("@reduxjs/toolkit").Reducer<QuerySuggestSet> & {
-    getInitialState: () => QuerySuggestSet;
+export declare const querySuggestReducer: import("@reduxjs/toolkit").Reducer<import("./query-suggest-state.js").QuerySuggestSet> & {
+    getInitialState: () => import("./query-suggest-state.js").QuerySuggestSet;
 };

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/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

@@ -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/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/index.d.ts

@@ -63,7 +63,7 @@ export type { FieldSuggestions, FieldSuggestionsOptions, FieldSuggestionsProps,
 export { buildFieldSuggestions } from './controllers/field-suggestions/facet/headless-field-suggestions.js';
 export type { FoldedCollection, FoldedResult, FoldedResultList, FoldedResultListOptions, FoldedResultListProps, FoldedResultListState, FoldingOptions, } from './controllers/folded-result-list/headless-folded-result-list.js';
 export { buildFoldedResultList } from './controllers/folded-result-list/headless-folded-result-list.js';
-export type { GeneratedAnswer, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedResponseFormat, } from './controllers/generated-answer/headless-generated-answer.js';
+export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedResponseFormat, } from './controllers/generated-answer/headless-generated-answer.js';
 export { buildGeneratedAnswer } from './controllers/generated-answer/headless-generated-answer.js';
 export type { InteractiveCitation, InteractiveCitationOptions, InteractiveCitationProps, } from './controllers/generated-answer/headless-interactive-citation.js';
 export { buildInteractiveCitation } from './controllers/generated-answer/headless-interactive-citation.js';

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

@@ -8,5 +8,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 {};