@coveo/quantic 3.36.7 → 3.36.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/quantic",
-  "version": "3.36.7",
+  "version": "3.36.8",
   "description": "A Salesforce Lightning Web Component (LWC) library for building modern UIs interfacing with the Coveo platform",
   "author": "coveo.com",
   "homepage": "https://coveo.com",
@@ -15,7 +15,7 @@
     "dompurify": "3.2.6",
     "marked": "12.0.2",
     "@coveo/bueno": "1.1.7",
-    "@coveo/headless": "3.46.1"
+    "@coveo/headless": "3.47.0"
   },
   "engines": {
     "node": "^20.9.0 || ^22.11.0 || ^24.11.0"

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

@@ -1,29 +0,0 @@
-import type { BaseQueryFn, CombinedState, FetchArgs, FetchBaseQueryError, QueryDefinition, RetryOptions } from '@reduxjs/toolkit/query';
-import type { GeneratedAnswerCitation, GeneratedContentFormat } from '../../../index.js';
-import type { SearchAppState } from '../../../state/search-app-state.js';
-import type { ConfigurationSection, GeneratedAnswerSection, TabSection } from '../../../state/state-sections.js';
-import type { AnswerEndpointArgs } from './endpoints/answer/answer-endpoint.js';
-export interface GeneratedAnswerServerState {
-    answerId?: string;
-    contentFormat?: GeneratedContentFormat;
-    answer?: string;
-    citations?: GeneratedAnswerCitation[];
-    generated?: boolean;
-    isStreaming: boolean;
-    isLoading: boolean;
-    error?: {
-        message?: string;
-        code?: number;
-    };
-}
-export declare const initialAnswerGenerationServerState: () => GeneratedAnswerServerState;
-interface AnswerGenerationApiSection {
-    answerGenerationApi: CombinedState<{
-        generateAnswer: QueryDefinition<AnswerEndpointArgs, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {} & RetryOptions, {}>, never, GeneratedAnswerServerState, 'answerGenerationApi'>;
-    }, never, 'answerGenerationApi'>;
-}
-export type AnswerGenerationApiState = {
-    searchHub: string;
-    pipeline: string;
-} & AnswerGenerationApiSection & ConfigurationSection & Partial<SearchAppState> & GeneratedAnswerSection & Partial<TabSection>;
-export {};

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

@@ -1,4 +0,0 @@
-/**
- * RTK Query API for answer generation operations.
- */
-export declare const answerGenerationApi: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {}, "answerGenerationApi", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;

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

@@ -1,30 +0,0 @@
-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';
-/**
- * Parameters for answer generation requests.
- */
-export type AnswerParams = {
-    q: string;
-    facets?: AnyFacetRequest[];
-    searchHub?: string;
-    pipeline?: string;
-    pipelineRuleParameters: PipelineRuleParameters;
-    locale: string;
-} & AnalyticsParam;
-/**
- * Arguments for the answer endpoint including streaming strategy and request parameters.
- */
-export type AnswerEndpointArgs = {
-    strategyKey: 'head-answer';
-} & AnswerParams;
-/**
- * RTK Query endpoint for streaming answer generation.
- */
-export declare const answerEndpoint: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
-    generateAnswer: 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">;
-}, "answerGenerationApi", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
-/**
- * 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>;

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

@@ -1,5 +0,0 @@
-import type { AnswerGenerationApiState } from '../../../answer-generation-api-state.js';
-/**
- * Builds the complete URL for the answer generation endpoint.
- */
-export declare const buildAnswerEndpointUrl: (state: AnswerGenerationApiState) => string;

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

@@ -1,24 +0,0 @@
-import { type GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
-/**
- * Parameters for follow-up answer generation requests.
- */
-export type FollowUpAnswerParams = {
-    q: string;
-    conversationId: string;
-};
-/**
- * Arguments for the follow-up answer endpoint including streaming strategy and request parameters.
- */
-export type FollowUpEndpointArgs = {
-    strategyKey: 'follow-up-answer';
-} & FollowUpAnswerParams;
-/**
- * RTK Query endpoint for streaming follow-up answer generation.
- */
-export declare const followUpEndpoint: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
-    generateFollowUpAnswer: 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">;
-}, "answerGenerationApi", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
-/**
- * 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>;

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

@@ -1,5 +0,0 @@
-import type { AnswerGenerationApiState } from '../../../answer-generation-api-state.js';
-/**
- * Builds the complete URL for the follow up endpoint.
- */
-export declare const buildFollowUpEndpointUrl: (state: AnswerGenerationApiState) => string;

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

@@ -1,26 +0,0 @@
-import type { GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
-import type { Message, StreamPayload } from '../types.js';
-/**
- * Sets the answer ID in the draft state if provided.
- */
-export declare const setAnswerId: (draft: GeneratedAnswerServerState, answerId: string) => void;
-/**
- * Initializes streaming by setting content format and updating streaming flags.
- */
-export declare const initializeStreamingAnswer: (draft: GeneratedAnswerServerState, payload: Pick<GeneratedAnswerServerState, "contentFormat">) => void;
-/**
- * Appends or sets answer text from streaming deltas.
- */
-export declare const setAnswer: (draft: GeneratedAnswerServerState, payload: Pick<StreamPayload, "textDelta">) => void;
-/**
- * Updates the citations list in the draft state.
- */
-export declare const setCitations: (draft: GeneratedAnswerServerState, payload: Pick<StreamPayload, "citations">) => void;
-/**
- * Finalizes streaming by marking it complete and stopping the stream.
- */
-export declare const endStreaming: (draft: GeneratedAnswerServerState, payload: Pick<StreamPayload, "answerGenerated">) => void;
-/**
- * Sets error state and stops streaming when an error occurs.
- */
-export declare const setAnswerError: (draft: GeneratedAnswerServerState, message: Message) => void;

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

@@ -1,26 +0,0 @@
-import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
-import type { GeneratedAnswerServerState } from '../answer-generation-api-state.js';
-import type { StreamingStrategy } from './types.js';
-type StateWithConfiguration = {
-    configuration: {
-        accessToken: string;
-    };
-};
-/**
- * Streams answer generation from an endpoint using a specified strategy.
- *
- * Establishes a server-sent events connection to stream answer generation responses.
- * Coordinates between server state updates (via serverStateEventHandler) and
- * application-specific logic (via strategy handlers).
- *
- * @param endpointUrl - The streaming endpoint URL
- * @param args - Request arguments to send in the POST body
- * @param api - Redux toolkit query API with state getter, dispatch, and cache updater
- * @param strategy - Strategy defining application-specific event handlers
- */
-export declare const streamAnswerWithStrategy: <TArgs, TState extends StateWithConfiguration>(endpointUrl: string, args: TArgs, api: {
-    getState: () => TState;
-    dispatch: ThunkDispatch<TState, unknown, UnknownAction>;
-    updateCachedData: (updater: (draft: GeneratedAnswerServerState) => void) => void;
-}, strategy: StreamingStrategy<TState>) => Promise<void>;
-export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/server-state-event-handler/server-state-event-handler.d.ts

@@ -1,21 +0,0 @@
-import type { GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
-import type { EventType, Message } from '../types.js';
-/**
- * Event handler interface for managing answer server state updates during answer streaming.
- */
-interface ServerStateEventHandler<TDraft = GeneratedAnswerServerState> {
-    /**
-     * Extracts and stores the answer ID from response headers.
-     */
-    handleOpen: (response: Response, updateCachedData: (updater: (draft: TDraft) => void) => void) => void;
-    /**
-     * Handlers for different streaming message types that update cached server state.
-     */
-    handleMessage: Partial<Record<EventType, (message: Message, updateCachedData: (updater: (draft: TDraft) => void) => void) => void>>;
-    handleError?: (error: unknown) => void;
-}
-/**
- * Manages answer server state updates during answer generation streaming.
- */
-export declare const serverStateEventHandler: ServerStateEventHandler;
-export {};

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

@@ -1,4 +0,0 @@
-export declare const streamingStrategyCreators: {
-    'head-answer': () => import("../types.js").StreamingStrategy<import("../../answer-generation-api-state.js").AnswerGenerationApiState>;
-    'follow-up-answer': () => import("../types.js").StreamingStrategy<import("../../answer-generation-api-state.js").AnswerGenerationApiState>;
-};

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

@@ -1,41 +0,0 @@
-import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
-import type { GeneratedContentFormat } from '../../../../features/generated-answer/generated-response-format.js';
-import type { GeneratedAnswerCitation } from '../../../generated-answer/generated-answer-event-payload.js';
-/**
- * Message types received during answer generation streaming.
- */
-type PayloadType = 'agentInteraction.answerHeader' | 'generativeengines.messageType' | 'agentInteraction.citations' | 'generativeengines.headerMessageType' | 'generativeengines.endOfStreamType';
-/**
- * Event types including standard payload types and error events.
- */
-export type EventType = PayloadType | 'error';
-/**
- * Parsed payload data from streaming messages.
- */
-export interface StreamPayload {
-    textDelta?: string;
-    padding?: string;
-    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.
- * Defines handlers for connection lifecycle and message processing.
- */
-export interface StreamingStrategy<TState> {
-    handleOpen: (response: Response, dispatch: ThunkDispatch<TState, unknown, UnknownAction>) => void;
-    handleError: (error: unknown) => void;
-    handleMessage: Partial<Record<EventType, (message: Message, dispatch: ThunkDispatch<TState, unknown, UnknownAction>) => void>>;
-    handleClose?: (dispatch: ThunkDispatch<TState, unknown, UnknownAction>) => void;
-}
-export {};

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

@@ -1,4 +0,0 @@
-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-answer-strategy.d.ts

@@ -1,3 +0,0 @@
-import type { AnswerGenerationApiState } from '../../api/knowledge/answer-generation/answer-generation-api-state.js';
-import type { StreamingStrategy } from '../../api/knowledge/answer-generation/streaming/types.js';
-export declare const createFollowUpAnswerStrategy: () => StreamingStrategy<AnswerGenerationApiState>;

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

@@ -1,3 +0,0 @@
-import type { AnswerGenerationApiState } from '../../api/knowledge/answer-generation/answer-generation-api-state.js';
-import type { StreamingStrategy } from '../../api/knowledge/answer-generation/streaming/types.js';
-export declare const createHeadAnswerStrategy: () => StreamingStrategy<AnswerGenerationApiState>;