@coveo/quantic 3.41.0 → 3.42.1

package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts

@@ -84,7 +84,7 @@ export { buildRecentQueriesList } from './controllers/commerce/recent-queries-li
 export type { Recommendations, RecommendationsOptions, RecommendationsProps, RecommendationsState, } from './controllers/commerce/recommendations/headless-recommendations.js';
 export { buildRecommendations } from './controllers/commerce/recommendations/headless-recommendations.js';
 export type { RecommendationsSummaryState } from './controllers/commerce/recommendations/summary/headless-recommendations-summary.js';
-export type { DidYouMean, DidYouMeanState, QueryCorrection, WordCorrection, } from './controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
+export type { DidYouMean, DidYouMeanOptions, DidYouMeanState, QueryCorrection, WordCorrection, } from './controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
 export type { Search, SearchOptions, SearchState, } from './controllers/commerce/search/headless-search.js';
 export { buildSearch } from './controllers/commerce/search/headless-search.js';
 export type { SearchSummaryState } from './controllers/commerce/search/summary/headless-search-summary.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.d.ts

@@ -114,7 +114,9 @@ export interface SearchAndListingSubControllerProps<P extends Parameters, S exte
  * @param subControllerProps - The properties for the search sub-controllers.
  * @returns The search sub-controllers.
  */
-export declare function buildSearchSubControllers(engine: CommerceEngine, subControllerProps: Omit<SearchAndListingSubControllerProps<CommerceSearchParameters, SearchSummaryState>, 'facetSearchType'>): SearchSubControllers;
+export declare function buildSearchSubControllers(engine: CommerceEngine, subControllerProps: Omit<SearchAndListingSubControllerProps<CommerceSearchParameters, SearchSummaryState>, 'facetSearchType'>, options?: {
+    enableResults?: boolean;
+}): SearchSubControllers;
 /**
  * Builds the sub-controllers for the commerce product listing use case.
  *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recent-queries-list/headless-recent-queries-list.d.ts

@@ -1,7 +1,18 @@
 import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
 import { type Controller } from '../../controller/headless-controller.js';
-import type { RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesListProps } from '../../recent-queries-list/headless-recent-queries-list.js';
-export type { RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesListProps, };
+import type { RecentQueriesListInitialState, RecentQueriesListOptions as CoreRecentQueriesListOptions, RecentQueriesListProps as CoreRecentQueriesListProps } from '../../recent-queries-list/headless-recent-queries-list.js';
+export type { RecentQueriesListInitialState };
+export type RecentQueriesListOptions = Partial<CoreRecentQueriesListOptions> & {
+    /**
+     * When set to true, fills the `results` field rather than the `products` field
+     * in the response. It may also include Spotlight Content in the results.
+     * @default false
+     */
+    enableResults?: boolean;
+};
+export interface RecentQueriesListProps extends Omit<CoreRecentQueriesListProps, 'options'> {
+    options?: RecentQueriesListOptions;
+}
 /**
  * The `RecentQueriesList` controller manages the user's recent queries.
  *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search/did-you-mean/headless-did-you-mean.d.ts

@@ -23,13 +23,22 @@ export interface DidYouMean extends Controller {
      */
     state: DidYouMeanState;
 }
+export interface DidYouMeanOptions {
+    /**
+     * When set to true, fills the `results` field rather than the `products` field
+     * in the response. It may also include Spotlight Content in the results.
+     * @default false
+     */
+    enableResults?: boolean;
+}
 /**
  * The `DidYouMean` controller is responsible for handling query corrections.
  *
  * @param engine - The commerce engine.
+ * @param options - The configurable `DidYouMean` options.
  * @returns A `DidYouMean` controller.
  *
  * @group Sub-controllers
  * @category DidYouMean
  */
-export declare function buildDidYouMean(engine: CommerceEngine): DidYouMean;
+export declare function buildDidYouMean(engine: CommerceEngine, options?: DidYouMeanOptions): DidYouMean;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/generated-answer/headless-generated-answer.d.ts

@@ -1,10 +1,10 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
 import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { GeneratedAnswerBase, GeneratedAnswerState, GenerationStep, GenerationStepName } from '../../features/generated-answer/generated-answer-state.js';
+import type { GeneratedAnswerBase, GeneratedAnswerState, GenerationStep, GenerationStepName, GenerationToolCall, GenerationToolCallType, GenerationToolCallArgsGeneric, GenerationToolCallArgsSearch } from '../../features/generated-answer/generated-answer-state.js';
 import type { GeneratedResponseFormat } from '../../features/generated-answer/generated-response-format.js';
 import type { GeneratedAnswer, GeneratedAnswerProps, GeneratedAnswerPropsInitialState } from '../core/generated-answer/headless-core-generated-answer.js';
 import { type GeneratedAnswerWithFollowUps, type GeneratedAnswerWithFollowUpsState } from '../knowledge/generated-answer/headless-generated-answer-with-follow-ups.js';
-export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedResponseFormat, GenerationStep, GenerationStepName, };
+export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedResponseFormat, GenerationStep, GenerationStepName, GenerationToolCall, GenerationToolCallArgsSearch, GenerationToolCallArgsGeneric, GenerationToolCallType, };
 /**
  * Creates a `GeneratedAnswer` controller instance.
 

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

@@ -1,5 +1,5 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
-import { type GenerationStepName } from '../generated-answer/generated-answer-state.js';
+import { type GenerationStepName, type GenerationToolCallArgsGeneric, type GenerationToolCallArgsSearch, type GenerationToolCallType } from '../generated-answer/generated-answer-state.js';
 import type { GeneratedContentFormat } from '../generated-answer/generated-response-format.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>;
@@ -105,3 +105,34 @@ export declare const followUpStepFinished: import("@reduxjs/toolkit").ActionCrea
 }, "name"> & {
     name: GenerationStepName;
 }, "followUpAnswers/stepFinished", never, never>;
+export declare const followUpToolCallStarted: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    toolCallName: string;
+    startedAt: number;
+    toolCallId: string;
+}], {
+    answerId: string;
+    toolCallName: string;
+    startedAt: number;
+    toolCallId: string;
+}, "followUpAnswers/startToolCall", never, never>;
+export declare const followUpToolCallFinished: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    finishedAt: number;
+    toolCallId: string;
+}], {
+    answerId: string;
+    finishedAt: number;
+    toolCallId: string;
+}, "followUpAnswers/finishToolCall", never, never>;
+export declare const followUpToolCallArgs: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    toolCallId: string;
+    args: GenerationToolCallArgsSearch | GenerationToolCallArgsGeneric;
+    type: GenerationToolCallType;
+}], {
+    answerId: string;
+    toolCallId: string;
+    args: GenerationToolCallArgsSearch | GenerationToolCallArgsGeneric;
+    type: GenerationToolCallType;
+}, "followUpAnswers/toolCallArgs", never, never>;

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

@@ -4,7 +4,7 @@ import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api
 import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
 import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
 import type { ConfigurationSection, DebugSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
-import { type GenerationStepName } from './generated-answer-state.js';
+import { type GenerationStepName, type GenerationToolCallArgsGeneric, type GenerationToolCallArgsSearch, type GenerationToolCallType } from './generated-answer-state.js';
 import { type GeneratedResponseFormat } from './generated-response-format.js';
 type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection & DebugSection;
 export declare const citationSchema: {
@@ -66,6 +66,31 @@ export declare const finishStep: import("@reduxjs/toolkit").ActionCreatorWithPre
 }, "name"> & {
     name: GenerationStepName;
 }, "generatedAnswer/finishStep", never, never>;
+export declare const startToolCall: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    toolCallName: string;
+    startedAt: number;
+    toolCallId: string;
+}], {
+    toolCallName: string;
+    startedAt: number;
+    toolCallId: string;
+}, "generatedAnswer/startToolCall", never, never>;
+export declare const finishToolCall: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    finishedAt: number;
+    toolCallId: string;
+}], {
+    finishedAt: number;
+    toolCallId: string;
+}, "generatedAnswer/finishToolCall", never, never>;
+export declare const toolCallArgs: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    toolCallId: string;
+    args: GenerationToolCallArgsSearch | GenerationToolCallArgsGeneric;
+    type: GenerationToolCallType;
+}], {
+    toolCallId: string;
+    args: GenerationToolCallArgsSearch | GenerationToolCallArgsGeneric;
+    type: GenerationToolCallType;
+}, "generatedAnswer/toolCallArgs", never, never>;
 interface StreamAnswerArgs {
     setAbortControllerRef: (ref: AbortController) => void;
 }

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

@@ -5,11 +5,30 @@ type GenerationStepStatus = 'active' | 'completed';
 export type GenerationStepName = (typeof GENERATION_STEP_NAMES)[number];
 export declare const GENERATION_STEP_NAMES: readonly ["searching", "thinking", "answering"];
 export declare function normalizeGenerationStepName(name: string): GenerationStepName;
+type GenerationToolCallStatus = 'active' | 'completed';
+export type GenerationToolCallType = (typeof GENERATION_TOOL_CALL_TYPES)[number];
+export declare const GENERATION_TOOL_CALL_TYPES: readonly ["search", "generic"];
+export interface GenerationToolCallArgsGeneric {
+    raw: string;
+}
+export interface GenerationToolCallArgsSearch {
+    q: string;
+}
+export interface GenerationToolCall {
+    toolCallName: string;
+    toolCallId: string;
+    startedAt: number;
+    finishedAt?: number;
+    status: GenerationToolCallStatus;
+    type?: GenerationToolCallType;
+    toolCallArgs?: GenerationToolCallArgsSearch | GenerationToolCallArgsGeneric;
+}
 export interface GenerationStep {
     name: GenerationStepName;
     status: GenerationStepStatus;
     startedAt: number;
     finishedAt?: number;
+    toolCalls?: Array<GenerationToolCall>;
 }
 /**
  * Base interface for generated answer structures.

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, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedResponseFormat, GenerationStep, GenerationStepName, } from './controllers/generated-answer/headless-generated-answer.js';
+export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedResponseFormat, GenerationStep, GenerationStepName, GenerationToolCall, GenerationToolCallArgsSearch, GenerationToolCallArgsGeneric, GenerationToolCallType, } 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/ssr/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.d.ts

@@ -1,10 +1,11 @@
-import type { DidYouMean, DidYouMeanState } from '../../../../controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
+import type { DidYouMean, DidYouMeanOptions, DidYouMeanState } from '../../../../controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
 import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { DidYouMean, DidYouMeanState };
+export type { DidYouMean, DidYouMeanOptions, DidYouMeanState };
 /**
  * Defines a `DidYouMean` controller instance.
  * @group Definers
  *
+ * @param options - The configurable `DidYouMean` options.
  * @returns The `DidYouMean` controller definition.
  */
-export declare function defineDidYouMean(): SearchOnlyControllerDefinitionWithoutProps<DidYouMean>;
+export declare function defineDidYouMean(options?: DidYouMeanOptions): SearchOnlyControllerDefinitionWithoutProps<DidYouMean>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts

@@ -87,7 +87,7 @@ export type { Cart, CartBuildProps, CartDefinition, CartInitialState, CartItem,
 export { defineCart } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
 export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, CustomContext, UserLocation, View, } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
 export { defineContext } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
-export type { DidYouMean, DidYouMeanDefinition, DidYouMeanState, } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
+export type { DidYouMean, DidYouMeanDefinition, DidYouMeanOptions, DidYouMeanState, } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
 export { defineDidYouMean } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
 export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, FieldSuggestionsFacet, FilterSuggestions, FilterSuggestionsGenerator, FilterSuggestionsGeneratorDefinition, FilterSuggestionsState, GeneratedFilterSuggestionsControllers, } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
 export { defineFilterSuggestionsGenerator } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce.index.d.ts

@@ -82,7 +82,7 @@ export type { Cart, CartBuildProps, CartDefinition, CartInitialState, CartItem,
 export { defineCart } from './ssr/commerce/controllers/cart/headless-cart.ssr.js';
 export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, CustomContext, UserLocation, View, } from './ssr/commerce/controllers/context/headless-context.ssr.js';
 export { defineContext } from './ssr/commerce/controllers/context/headless-context.ssr.js';
-export type { DidYouMean, DidYouMeanState, } from './ssr/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
+export type { DidYouMean, DidYouMeanOptions, DidYouMeanState, } from './ssr/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
 export { defineDidYouMean } from './ssr/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
 export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, FieldSuggestionsFacet, FilterSuggestions, FilterSuggestionsGenerator, FilterSuggestionsGeneratorDefinition, FilterSuggestionsState, GeneratedFilterSuggestionsControllers, } from './ssr/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
 export { defineFilterSuggestionsGenerator } from './ssr/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.d.ts

@@ -1,11 +1,12 @@
-import type { DidYouMean, DidYouMeanState } from '../../../../controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
+import type { DidYouMean, DidYouMeanOptions, DidYouMeanState } from '../../../../controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
 import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { DidYouMean, DidYouMeanState };
+export type { DidYouMean, DidYouMeanOptions, DidYouMeanState };
 export type DidYouMeanDefinition = SearchOnlyControllerDefinitionWithoutProps<DidYouMean>;
 /**
  * Defines a `DidYouMean` controller instance.
  * @group Definers
  *
+ * @param options - The configurable `DidYouMean` options.
  * @returns The `DidYouMean` controller definition.
  */
-export declare function defineDidYouMean(): DidYouMeanDefinition;
+export declare function defineDidYouMean(options?: DidYouMeanOptions): DidYouMeanDefinition;