@coveo/quantic 3.36.3 → 3.36.5

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

@@ -3,5 +3,5 @@ import type { BaseParam } from './platform-service-params.js';
 import type { AllSearchAPIResponse } from './search/search-api-client.js';
 import type { SearchAPIErrorWithStatusCode } from './search/search-api-error-response.js';
 import type { AuthenticationParam } from './search/search-api-params.js';
-export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "url" | "accessToken" | "organizationId" | "authentication">;
+export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "organizationId" | "accessToken" | "url" | "authentication">;
 export declare const unwrapError: (payload: PlatformResponse<AllSearchAPIResponse>) => SearchAPIErrorWithStatusCode;

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

@@ -5,7 +5,6 @@ import type { PlatformEnvironment } from '../../utils/url-utils.js';
 import type { PreprocessRequest } from '../preprocess-request.js';
 import type { SpecificFacetSearchResponse } from '../search/facet-search/specific-facet-search/specific-facet-search-response.js';
 import type { CommerceAPIErrorResponse, CommerceAPIErrorStatusResponse } from './commerce-api-error-response.js';
-import type { CommerceSuccessResponse } from './common/response.js';
 import type { CommerceFacetSearchRequest, FacetSearchType } from './facet-search/facet-search-request.js';
 import type { CommerceListingRequest } from './listing/request.js';
 import type { ListingCommerceSuccessResponse } from './listing/response.js';
@@ -13,6 +12,8 @@ import { type ProductEnrichmentBadgesRequest } from './product-enrichment/produc
 import type { ProductEnrichmentSuccessBadgesResponse } from './product-enrichment/product-enrichment-response.js';
 import { type CommerceRecommendationsRequest } from './recommendations/recommendations-request.js';
 import type { RecommendationsCommerceSuccessResponse } from './recommendations/recommendations-response.js';
+import { type CommercePlanRequest } from './search/plan/plan-request.js';
+import type { CommercePlanSuccessResponse } from './search/plan/plan-response.js';
 import { type QuerySuggestRequest } from './search/query-suggest/query-suggest-request.js';
 import type { QuerySuggestSuccessResponse } from './search/query-suggest/query-suggest-response.js';
 import type { CommerceSearchRequest } from './search/request.js';
@@ -44,7 +45,7 @@ export declare class CommerceAPIClient implements CommerceFacetSearchAPIClient {
     querySuggest(req: QuerySuggestRequest): Promise<CommerceAPIResponse<QuerySuggestSuccessResponse>>;
     facetSearch(req: CommerceFacetSearchRequest, type: FacetSearchType): Promise<CommerceAPIResponse<SpecificFacetSearchResponse>>;
     getBadges(req: ProductEnrichmentBadgesRequest): Promise<CommerceAPIResponse<ProductEnrichmentSuccessBadgesResponse>>;
-    plan(req: CommerceSearchRequest): Promise<CommerceAPIResponse<CommerceSuccessResponse>>;
+    plan(req: CommercePlanRequest): Promise<CommerceAPIResponse<CommercePlanSuccessResponse>>;
     private query;
 }
 export declare function getCommerceApiBaseUrl(organizationId: string, environment?: PlatformEnvironment): string;

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

@@ -1,4 +1,4 @@
-export type CommerceApiMethod = 'listing' | 'search' | 'recommendations' | 'search/productSuggest' | 'search/querySuggest' | 'querySuggest' | 'facet' | 'badges';
+export type CommerceApiMethod = 'listing' | 'search' | 'recommendations' | 'search/productSuggest' | 'search/querySuggest' | 'search/redirect' | 'querySuggest' | 'facet' | 'badges';
 /**
  * API methods that require the tracking ID to be included in the URL path.
  * These endpoints use the pattern: /tracking-ids/{trackingId}/{method}

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

@@ -29,10 +29,10 @@ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path
         facets: import("../../../features/commerce/facets/facet-set/interfaces/request.js").AnyFacetRequest[] | undefined;
         sort: import("./sort.js").SortOption | undefined;
     };
-    url: string;
-    origin: import("../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -21,10 +21,10 @@ export declare const buildProductEnrichmentBadgesRequest: (req: ProductEnrichmen
             custom?: Record<string, unknown>;
         };
     };
-    url: string;
-    origin: import("../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts

@@ -25,10 +25,10 @@ export declare const buildRecommendationsRequest: (req: CommerceRecommendationsR
         page: number | undefined;
         perPage: number | undefined;
     };
-    url: string;
-    origin: import("../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/plan/plan-request.d.ts

@@ -0,0 +1,31 @@
+import type { BaseParam } from '../../../platform-service-params.js';
+import type { ClientIdParam, ContextParam, CountryParam, CurrencyParam, LanguageParam, QueryParam, TrackingIdParam } from '../../commerce-api-params.js';
+export type CommercePlanRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & QueryParam;
+export declare const getPlanRequestOptions: (req: CommercePlanRequest) => {
+    requestParams: {
+        trackingId: string;
+        query: string | undefined;
+        clientId: string | undefined;
+        context: {
+            view: import("../../commerce-api-params.js").ViewParams;
+            user?: import("../../commerce-api-params.js").UserParams;
+            product?: {
+                productId: string;
+            };
+            cart?: import("../../commerce-api-params.js").CartItemParam[];
+            purchased?: import("../../commerce-api-params.js").CartItemParam[];
+            capture: boolean;
+            source: string[];
+            custom?: Record<string, unknown>;
+        };
+        language: string;
+        country: string;
+        currency: string;
+    };
+    method: import("../../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
+    contentType: import("../../../platform-client.js").HTTPContentType;
+    requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/plan/plan-response.d.ts

@@ -0,0 +1,8 @@
+export interface CommercePlanSuccessResponse {
+    /**
+     * The URL to redirect the user to.
+     * (Null if there isn't one.)
+     * @example https://www.example.com/
+     */
+    redirect: string | null;
+}

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts

@@ -22,10 +22,10 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
         country: string;
         currency: string;
     };
-    url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -1,6 +1,6 @@
 import type { AnyFacetRequest } from '../../../../../features/facets/generic/interfaces/generic-facet-request.js';
 import type { AnalyticsParam, PipelineRuleParameters } from '../../../../search/search-api-params.js';
-import { type GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
+import { type AnswerGenerationApiState, type GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
 /**
  * Parameters for answer generation requests.
  */
@@ -28,3 +28,71 @@ export declare const answerEndpoint: import("@reduxjs/toolkit/query").Api<import
  * Initiates an answer generation query with the specified strategy and parameters.
  */
 export declare const initiateAnswerEndpoint: (args: AnswerEndpointArgs) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<AnswerEndpointArgs, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerServerState, "answerGenerationApi">>, any, any, import("@reduxjs/toolkit").UnknownAction>;
+/**
+ * Selects the cached answer generation data for the specified query parameters from the state.
+ *
+ * @param args - The answer endpoint arguments including strategy and parameters.
+ * @param state - The current answer generation API state.
+ * @returns The cached answer generation query result.
+ */
+export declare const selectAnswer: (args: AnswerEndpointArgs, state: AnswerGenerationApiState) => ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    originalArgs?: undefined | undefined;
+    data?: undefined | undefined;
+    error?: undefined | undefined;
+    requestId?: undefined | undefined;
+    endpointName?: string | undefined;
+    startedTimeStamp?: undefined | undefined;
+    fulfilledTimeStamp?: undefined | undefined;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    isUninitialized: true;
+    isLoading: false;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+    error: undefined;
+    requestId: string;
+    originalArgs: AnswerEndpointArgs;
+    endpointName: string;
+    startedTimeStamp: number;
+    data: GeneratedAnswerServerState;
+    fulfilledTimeStamp: number;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: true;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+    originalArgs: AnswerEndpointArgs;
+    requestId: string;
+    data?: GeneratedAnswerServerState | undefined;
+    error?: import("@reduxjs/toolkit/query").FetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number | undefined;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+    isUninitialized: false;
+    isLoading: true;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+    data?: GeneratedAnswerServerState | undefined;
+    requestId: string;
+    fulfilledTimeStamp?: number | undefined;
+    originalArgs: AnswerEndpointArgs;
+    endpointName: string;
+    startedTimeStamp: number;
+    error: import("@reduxjs/toolkit/query").FetchBaseQueryError | import("@reduxjs/toolkit").SerializedError;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: false;
+    isError: true;
+});

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/follow-up/follow-up-endpoint.d.ts

@@ -2,7 +2,7 @@ import { type GeneratedAnswerServerState } from '../../answer-generation-api-sta
 /**
  * Parameters for follow-up answer generation requests.
  */
-type FollowUpAnswerParams = {
+export type FollowUpAnswerParams = {
     q: string;
     conversationId: string;
 };
@@ -22,4 +22,3 @@ export declare const followUpEndpoint: import("@reduxjs/toolkit/query").Api<impo
  * Initiates a follow up answer generation query with the specified strategy and parameters.
  */
 export declare const initiateFollowUpEndpoint: (args: FollowUpEndpointArgs) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<FollowUpEndpointArgs, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerServerState, "answerGenerationApi">>, any, any, import("@reduxjs/toolkit").UnknownAction>;
-export {};

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

@@ -4,17 +4,7 @@ import type { GeneratedAnswerCitation } from '../../../generated-answer/generate
 /**
  * Message types received during answer generation streaming.
  */
-type PayloadType = 'genqa.headerMessageType' | 'genqa.messageType' | 'genqa.citationsType' | 'genqa.endOfStreamType';
-/**
- * Represents a streaming message from the answer generation endpoint.
- */
-export interface Message {
-    payloadType: PayloadType;
-    payload: string;
-    finishReason?: string;
-    errorMessage?: string;
-    code?: number;
-}
+type PayloadType = 'agentInteraction.answerHeader' | 'generativeengines.messageType' | 'agentInteraction.citations' | 'generativeengines.headerMessageType' | 'generativeengines.endOfStreamType';
 /**
  * Event types including standard payload types and error events.
  */
@@ -28,6 +18,15 @@ export interface StreamPayload {
     answerGenerated?: boolean;
     contentFormat?: GeneratedContentFormat;
     citations?: GeneratedAnswerCitation[];
+    conversationId?: string;
+    followUpEnabled?: boolean;
+}
+export interface Message {
+    payloadType: PayloadType;
+    payload: StreamPayload;
+    finishReason?: string;
+    errorMessage?: string;
+    code?: number;
 }
 /**
  * Strategy interface for handling application-specific streaming events.

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

@@ -44,7 +44,7 @@ export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
     originalArgs: AnswerApiQueryParams;
     requestId: string;
     data?: GeneratedAnswerStream | undefined;
-    error?: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/query").FetchBaseQueryError | undefined;
+    error?: import("@reduxjs/toolkit/query").FetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
     endpointName: string;
     startedTimeStamp: number;
     fulfilledTimeStamp?: number | undefined;
@@ -56,13 +56,13 @@ export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
     isError: false;
 }) | ({
     status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
-    requestId: string;
     data?: GeneratedAnswerStream | undefined;
+    requestId: string;
     fulfilledTimeStamp?: number | undefined;
     originalArgs: AnswerApiQueryParams;
     endpointName: string;
     startedTimeStamp: number;
-    error: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/query").FetchBaseQueryError;
+    error: import("@reduxjs/toolkit/query").FetchBaseQueryError | import("@reduxjs/toolkit").SerializedError;
 } & {
     status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
     isUninitialized: false;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts

@@ -11,9 +11,9 @@ export declare const buildGetCaseClassificationsRequest: (req: GetCaseClassifica
             };
         };
     };
-    url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts

@@ -28,9 +28,9 @@ export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSugges
             source?: string[];
         } | undefined;
     };
-    url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts

@@ -3,9 +3,9 @@ import { type InsightIdParam } from '../insight-params.js';
 export type GetInsightInterfaceConfigRequest = BaseParam & InsightIdParam;
 export declare const buildGetInsightInterfaceConfigRequest: (req: GetInsightInterfaceConfigRequest) => {
     requestParams: {};
-    url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts

@@ -8,17 +8,17 @@ export interface CaseContextParam {
 }
 export declare const buildInsightQueryRequest: (req: InsightQueryRequest) => {
     requestParams: {};
-    url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };
 export declare const buildInsightQuerySuggestRequest: (req: InsightQuerySuggestRequest) => {
     requestParams: {};
-    url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts

@@ -10,10 +10,10 @@ export declare const buildInsightUserActionsRequest: (req: InsightUserActionsReq
     requestParams: {
         objectId: string;
     };
-    url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
-    accessToken: string;
     method: import("../../../platform-client.js").HttpMethods;
+    accessToken: string;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    url: string;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/app/listener-middleware/generate-answer-listener-middleware.d.ts

@@ -0,0 +1,4 @@
+import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
+import type { AnswerGenerationApiState } from '../../api/knowledge/answer-generation/answer-generation-api-state.js';
+import type { SearchThunkExtraArguments } from '../search-thunk-extra-arguments.js';
+export declare const generateAnswerListener: import("@reduxjs/toolkit").ListenerMiddlewareInstance<AnswerGenerationApiState, ThunkDispatch<AnswerGenerationApiState, SearchThunkExtraArguments, UnknownAction>, unknown>;

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

@@ -118,6 +118,10 @@ export interface GeneratedAnswerProps extends GeneratedAnswerPropsInitialState {
      * The answer configuration ID used to leverage coveo answer management capabilities.
      */
     answerConfigurationId?: string;
+    /**
+     * The agent ID that identifies the agent used for generating the answer.
+     */
+    agentId?: string;
     /**
      * A list of indexed fields to include in the citations returned with the generated answer.
      */

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

@@ -1,9 +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 { GeneratedAnswerState } from '../../features/generated-answer/generated-answer-state.js';
+import type { GeneratedAnswerBase, GeneratedAnswerState } 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';
-export type { GeneratedAnswerCitation, GeneratedResponseFormat, GeneratedAnswerState, GeneratedAnswer, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, };
+import { type GeneratedAnswerWithFollowUps } from '../knowledge/generated-answer/headless-generated-answer-with-follow-ups.js';
+export type { GeneratedAnswerCitation, GeneratedResponseFormat, GeneratedAnswerState, GeneratedAnswer, GeneratedAnswerWithFollowUps, GeneratedAnswerBase, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, };
 /**
  * Creates a `GeneratedAnswer` controller instance.
 
@@ -14,4 +15,4 @@ export type { GeneratedAnswerCitation, GeneratedResponseFormat, GeneratedAnswerS
  * @group Controllers
  * @category GeneratedAnswer
  */
-export declare function buildGeneratedAnswer(engine: SearchEngine, props?: GeneratedAnswerProps): GeneratedAnswer;
+export declare function buildGeneratedAnswer(engine: SearchEngine, props?: GeneratedAnswerProps): GeneratedAnswer | GeneratedAnswerWithFollowUps;

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

@@ -0,0 +1,47 @@
+import type { InsightEngine } from '../../../app/insight-engine/insight-engine.js';
+import type { SearchEngine } from '../../../app/search-engine/search-engine.js';
+import type { FollowUpAnswersState } from '../../../features/follow-up-answers/follow-up-answers-state.js';
+import type { GeneratedAnswerState } from '../../../index.js';
+import { type GeneratedAnswer, type GeneratedAnswerAnalyticsClient, type GeneratedAnswerProps } from '../../core/generated-answer/headless-core-generated-answer.js';
+interface GeneratedAnswerWithFollowUpsState extends GeneratedAnswerState {
+    followUpAnswers: FollowUpAnswersState;
+}
+export interface GeneratedAnswerWithFollowUps extends GeneratedAnswer {
+    /**
+     * The state of the GeneratedAnswer controller.
+     */
+    state: GeneratedAnswerWithFollowUpsState;
+    /**
+     * Marks the answer as liked.
+     * @param answerId - Optional ID of the answer to like. Defaults to the head answer.
+     */
+    like(answerId?: string): void;
+    /**
+     * Marks the answer as disliked.
+     * @param answerId - Optional ID of the answer to dislike. Defaults to the head answer.
+     */
+    dislike(answerId?: string): void;
+    /**
+     * Logs a copy-to-clipboard interaction for analytics.
+     * @param answerId - Optional ID of the copied answer. Defaults to the current answer.
+     */
+    logCopyToClipboard(answerId?: string): void;
+    /**
+     * Asks a follow-up question.
+     * @param question - The follow-up question to ask.
+     */
+    askFollowUp(question: string): void;
+}
+export type GeneratedAnswerWithFollowUpsProps = GeneratedAnswerProps & Required<Pick<GeneratedAnswerProps, 'agentId'>>;
+/**
+ *
+ * @internal
+ *
+ * Creates a `GeneratedAnswerWithFollowUps` controller instance using the Answer API stream pattern.
+ *
+ * @param engine - The headless engine.
+ * @param props - The configurable `GeneratedAnswerWithFollowUps` properties.
+ * @returns A `GeneratedAnswerWithFollowUps` controller instance.
+ */
+export declare function buildGeneratedAnswerWithFollowUps(engine: SearchEngine | InsightEngine, analyticsClient: GeneratedAnswerAnalyticsClient, props: GeneratedAnswerWithFollowUpsProps): GeneratedAnswerWithFollowUps;
+export {};

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

@@ -98,4 +98,5 @@ export declare const validateResultPayload: (result: Result) => Partial<{
     rankingModifier: string;
 }>;
 export declare const analyticsEventItemMetadata: (result: Result, state: Partial<SearchAppState>) => ItemMetaData;
+export declare const analyticsEventItemMetadataForCitations: (citation: GeneratedAnswerCitation, state: Partial<SearchAppState>) => ItemMetaData;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-action-cause.d.ts

@@ -179,6 +179,10 @@ export declare enum SearchPageEvents {
      * Identifies the custom event that gets logged when a user clicks the Detach From Case result action.
      */
     caseDetach = "caseDetach",
+    /**
+     * Identifies the click event that gets logged when a user attaches a generated answer citation to a case.
+     */
+    generatedAnswerCitationDocumentAttach = "generatedAnswerCitationDocumentAttach",
     /**
      * Identifies the cause of a search request being retried in order to regenerate an answer stream that failed.
      */

package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-analytics-actions.d.ts

@@ -1,4 +1,5 @@
 import type { Result } from '../../api/search/search/result.js';
+import type { GeneratedAnswerCitation } from '../../index.js';
 export declare const logCaseAttach: (result: Result) => (() => import("@reduxjs/toolkit").AsyncThunkAction<void, void, {
     state: import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
     extra: import("../../app/thunk-extra-arguments.js").ThunkExtraArguments;
@@ -42,7 +43,7 @@ export declare const logCaseAttach: (result: Result) => (() => import("@reduxjs/
     typePrefix: string;
 } & {
     prepare: (options: {
-        analyticsClientMiddleware: import("coveo.analytics").AnalyticsClientSendEventHook;
+        analyticsClientMiddleware: import("coveo.analytics/dist/definitions/client/analytics.js").AnalyticsClientSendEventHook;
         preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
         logger: import("pino").Logger;
         getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
@@ -94,7 +95,111 @@ export declare const logCaseDetach: (result: Result) => (() => import("@reduxjs/
     typePrefix: string;
 } & {
     prepare: (options: {
-        analyticsClientMiddleware: import("coveo.analytics").AnalyticsClientSendEventHook;
+        analyticsClientMiddleware: import("coveo.analytics/dist/definitions/client/analytics.js").AnalyticsClientSendEventHook;
+        preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
+        logger: import("pino").Logger;
+        getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+    }) => Promise<{
+        description?: import("coveo.analytics").EventDescription;
+        action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;
+    }>;
+};
+export declare const logCitationDocumentAttach: (citation: GeneratedAnswerCitation) => (() => import("@reduxjs/toolkit").AsyncThunkAction<void, void, {
+    state: import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+    extra: import("../../app/thunk-extra-arguments.js").ThunkExtraArguments;
+}>) & {
+    pending: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[string, void, unknown?], undefined, string, never, {
+        arg: void;
+        requestId: string;
+        requestStatus: "pending";
+    }>;
+    rejected: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[Error | null, string, void, unknown?, unknown?], unknown, string, import("@reduxjs/toolkit").SerializedError, {
+        arg: void;
+        requestId: string;
+        requestStatus: "rejected";
+        aborted: boolean;
+        condition: boolean;
+    } & ({
+        rejectedWithValue: true;
+    } | ({
+        rejectedWithValue: false;
+    } & {}))>;
+    fulfilled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[void, string, void, unknown?], void, string, never, {
+        arg: void;
+        requestId: string;
+        requestStatus: "fulfilled";
+    }>;
+    settled: (action: any) => action is import("@reduxjs/toolkit").PayloadAction<void, string, {
+        arg: void;
+        requestId: string;
+        requestStatus: "fulfilled";
+    }, never> | import("@reduxjs/toolkit").PayloadAction<unknown, string, {
+        arg: void;
+        requestId: string;
+        requestStatus: "rejected";
+        aborted: boolean;
+        condition: boolean;
+    } & ({
+        rejectedWithValue: true;
+    } | ({
+        rejectedWithValue: false;
+    } & {})), import("@reduxjs/toolkit").SerializedError>;
+    typePrefix: string;
+} & {
+    prepare: (options: {
+        analyticsClientMiddleware: import("coveo.analytics/dist/definitions/client/analytics.js").AnalyticsClientSendEventHook;
+        preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
+        logger: import("pino").Logger;
+        getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+    }) => Promise<{
+        description?: import("coveo.analytics").EventDescription;
+        action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;
+    }>;
+};
+export declare const logCitationDocumentDetach: (citation: GeneratedAnswerCitation) => (() => import("@reduxjs/toolkit").AsyncThunkAction<void, void, {
+    state: import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+    extra: import("../../app/thunk-extra-arguments.js").ThunkExtraArguments;
+}>) & {
+    pending: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[string, void, unknown?], undefined, string, never, {
+        arg: void;
+        requestId: string;
+        requestStatus: "pending";
+    }>;
+    rejected: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[Error | null, string, void, unknown?, unknown?], unknown, string, import("@reduxjs/toolkit").SerializedError, {
+        arg: void;
+        requestId: string;
+        requestStatus: "rejected";
+        aborted: boolean;
+        condition: boolean;
+    } & ({
+        rejectedWithValue: true;
+    } | ({
+        rejectedWithValue: false;
+    } & {}))>;
+    fulfilled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[void, string, void, unknown?], void, string, never, {
+        arg: void;
+        requestId: string;
+        requestStatus: "fulfilled";
+    }>;
+    settled: (action: any) => action is import("@reduxjs/toolkit").PayloadAction<void, string, {
+        arg: void;
+        requestId: string;
+        requestStatus: "fulfilled";
+    }, never> | import("@reduxjs/toolkit").PayloadAction<unknown, string, {
+        arg: void;
+        requestId: string;
+        requestStatus: "rejected";
+        aborted: boolean;
+        condition: boolean;
+    } & ({
+        rejectedWithValue: true;
+    } | ({
+        rejectedWithValue: false;
+    } & {})), import("@reduxjs/toolkit").SerializedError>;
+    typePrefix: string;
+} & {
+    prepare: (options: {
+        analyticsClientMiddleware: import("coveo.analytics/dist/definitions/client/analytics.js").AnalyticsClientSendEventHook;
         preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
         logger: import("pino").Logger;
         getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-state.d.ts

@@ -39,6 +39,10 @@ export interface AttachedResult {
      * The uriHash of the attached result.
      */
     uriHash?: string;
+    /**
+     * Whether the attached result is a document that was attached from a citation.
+     */
+    isAttachedFromCitation?: boolean;
 }
 export interface AttachedResultsState {
     /**

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

@@ -0,0 +1,4 @@
+import { type FacetOrderState } from '../../../facets/facet-order/facet-order-state.js';
+export declare const commerceFacetOrderReducer: import("@reduxjs/toolkit").Reducer<FacetOrderState> & {
+    getInitialState: () => FacetOrderState;
+};