@coveo/quantic 3.43.3 → 3.43.5

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/case-assist-analytics.d.ts

@@ -13,6 +13,7 @@ interface ConfigureCaseAssistAnalyticsOptions {
     analyticsClientMiddleware?: AnalyticsClientSendEventHook;
     preprocessRequest?: PreprocessRequest;
     provider?: CaseAssistClientProvider;
+    disableBrowserPrivacySignals?: boolean;
 }
-export declare const configureCaseAssistAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: ConfigureCaseAssistAnalyticsOptions) => CaseAssistClient;
+export declare const configureCaseAssistAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, disableBrowserPrivacySignals, }: ConfigureCaseAssistAnalyticsOptions) => CaseAssistClient;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/insight-analytics.d.ts

@@ -27,6 +27,7 @@ interface ConfigureInsightAnalyticsOptions {
     preprocessRequest?: PreprocessRequest;
     provider?: InsightClientProvider;
     getState(): StateNeededByInsightAnalyticsProvider;
+    disableBrowserPrivacySignals?: boolean;
 }
-export declare const configureInsightAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: ConfigureInsightAnalyticsOptions) => CoveoInsightClient;
+export declare const configureInsightAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, disableBrowserPrivacySignals, }: ConfigureInsightAnalyticsOptions) => CoveoInsightClient;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/search-analytics.d.ts

@@ -96,8 +96,9 @@ interface LegacyConfigureAnalyticsOptions<State extends ConfigurationSection = S
     preprocessRequest?: PreprocessRequest;
     provider?: SearchPageClientProvider;
     getState(): State;
+    disableBrowserPrivacySignals?: boolean;
 }
-export declare const configureLegacyAnalytics: <State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider>({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions<State> & {
+export declare const configureLegacyAnalytics: <State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider>({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, disableBrowserPrivacySignals, }: LegacyConfigureAnalyticsOptions<State> & {
     provider: SearchPageClientProvider;
 }) => CoveoSearchPageClient;
 export declare const getPageID: () => string;

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

@@ -1,6 +1,9 @@
 import type { BaseParam } from '../../../platform-service-params.js';
 import type { ClientIdParam, ContextParam, CountryParam, CurrencyParam, LanguageParam, QueryParam, TrackingIdParam } from '../../commerce-api-params.js';
-export type QuerySuggestRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & QueryParam;
+interface CountParam {
+    count?: number;
+}
+export type QuerySuggestRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & QueryParam & CountParam;
 export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) => {
     requestParams: {
         trackingId: string;
@@ -21,6 +24,7 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
         language: string;
         country: string;
         currency: string;
+        count: number | undefined;
     };
     accessToken: string;
     url: string;
@@ -29,3 +33,4 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
 };
+export {};

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

@@ -1,9 +1,10 @@
 import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
+import type { GeneratedAnswerAnalyticsClient } from '../../features/generated-answer/generated-answer-analytics-client.js';
 import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
 import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
 import type { GeneratedAnswerStream } from './generated-answer-stream.js';
 import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
-export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction>) => void;
+export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction>, generatedAnswerAnalyticsClient: GeneratedAnswerAnalyticsClient) => void;
 export declare const buildAnswerEndpoint: (platformEndpoint: string, organizationId: string, answerConfigurationId: string, insightId?: string) => string;
 export declare const answerApi: 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, {}>, {
     getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<AnswerApiQueryParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer", unknown>;

package/force-app/main/default/staticresources/coveoheadless/definitions/app/engine-configuration.d.ts

@@ -138,6 +138,40 @@ export interface AnalyticsConfiguration {
      * See [Headless proxy: Analytics](https://docs.coveo.com/en/headless/latest/usage/proxy#analytics).
      */
     proxyBaseUrl?: string;
+    /**
+     * Whether to stop honoring browser privacy signals — Do Not Track (DNT) and
+     * Global Privacy Control (GPC) — when deciding whether to send **legacy**
+     * analytics (`analyticsMode: 'legacy'`).
+     *
+     * By default (`false`), Coveo libraries honor these signals: when the browser
+     * presents DNT or GPC, legacy analytics is automatically disabled. Setting this
+     * option to `true` is a deliberate choice that you configure in your own
+     * application code; legacy analytics events are then sent even when the browser
+     * presents a DNT or GPC signal.
+     *
+     * Coveo honors these signals by default and cannot determine whether overriding
+     * them is appropriate for your use case. If you enable this option, you are
+     * responsible for ensuring that doing so complies with the privacy laws and
+     * obligations that apply to you. Note that GPC is legally recognized as a valid
+     * opt-out mechanism in some jurisdictions (for example, under the California
+     * Consumer Privacy Act (CCPA) as amended by the California Privacy Rights Act
+     * (CPRA)).
+     *
+     * This option:
+     * - applies only when `analyticsMode` is explicitly set to `'legacy'`;
+     * - has no effect with `analyticsMode: 'next'`, which does not honor these signals;
+     * - does not override an explicit `enabled: false` or a runtime
+     *   `disableAnalytics()` call, which always disable analytics.
+     *
+     * @deprecated Introduced as deprecated on purpose to signal that it is
+     * transitional. This option exists only to bridge legacy-analytics deployments
+     * where a browser privacy signal is enforced by policy, and it will be removed
+     * when legacy analytics is removed (see KIT-2844). Migrate to Event Protocol
+     * (`analyticsMode: 'next'`) rather than relying on this option long term.
+     *
+     * @defaultValue `false`
+     */
+    disableBrowserPrivacySignals?: boolean;
 }
 export type AnalyticsRuntimeEnvironment = IRuntimeEnvironment;
 export declare const engineConfigurationDefinitions: SchemaDefinition<EngineConfiguration>;

package/force-app/main/default/staticresources/coveoheadless/definitions/app/insight-thunk-extra-arguments.d.ts

@@ -1,4 +1,6 @@
 import type { InsightAPIClient } from '../api/service/insight/insight-api-client.js';
+import type { GeneratedAnswerAnalyticsClient } from '../features/generated-answer/generated-answer-analytics-client.js';
 import type { ClientThunkExtraArguments } from './thunk-extra-arguments.js';
 export interface InsightThunkExtraArguments extends ClientThunkExtraArguments<InsightAPIClient> {
+    generatedAnswerAnalyticsClient: GeneratedAnswerAnalyticsClient;
 }

package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-thunk-extra-arguments.d.ts

@@ -1,5 +1,7 @@
 import type { GeneratedAnswerAPIClient } from '../api/generated-answer/generated-answer-client.js';
 import type { SearchAPIClient } from '../api/search/search-api-client.js';
+import type { GeneratedAnswerAnalyticsClient } from '../features/generated-answer/generated-answer-analytics-client.js';
 import type { ClientThunkExtraArguments } from './thunk-extra-arguments.js';
 export interface SearchThunkExtraArguments extends ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient> {
+    generatedAnswerAnalyticsClient: GeneratedAnswerAnalyticsClient;
 }

package/force-app/main/default/staticresources/coveoheadless/definitions/app/thunk-extra-arguments.d.ts

@@ -3,6 +3,7 @@ import type { AnalyticsClientSendEventHook } from 'coveo.analytics';
 import type { Logger } from 'pino';
 import type { GeneratedAnswerAPIClient } from '../api/generated-answer/generated-answer-client.js';
 import { type PreprocessRequest } from '../api/preprocess-request.js';
+import type { GeneratedAnswerAnalyticsClient } from '../features/generated-answer/generated-answer-analytics-client.js';
 import { validatePayloadAndThrow } from '../utils/validate-payload.js';
 import type { EngineConfiguration } from './engine-configuration.js';
 import type { NavigatorContext } from './navigator-context-provider.js';
@@ -11,11 +12,19 @@ export interface ClientThunkExtraArguments<T, K = GeneratedAnswerAPIClient> exte
     streamingClient?: K;
     relay: Relay;
     navigatorContext: NavigatorContext;
+    generatedAnswerAnalyticsClient?: GeneratedAnswerAnalyticsClient;
 }
 export interface ThunkExtraArguments {
     preprocessRequest?: PreprocessRequest;
     analyticsClientMiddleware: AnalyticsClientSendEventHook;
     logger: Logger;
     validatePayload: typeof validatePayloadAndThrow;
+    /**
+     * Legacy-analytics-only, immutable engine policy. When `true`, browser privacy
+     * signals (Do Not Track and Global Privacy Control) are not honored. Sourced from
+     * the engine configuration at build time and intentionally kept out of Redux
+     * analytics state so it cannot be mutated at runtime.
+     */
+    disableBrowserPrivacySignals?: boolean;
 }
 export declare function buildThunkExtraArguments(configuration: EngineConfiguration, logger: Logger): ThunkExtraArguments;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search-box/headless-search-box-options.d.ts

@@ -1,6 +1,12 @@
-import { BooleanValue, Schema } from '@coveo/bueno';
+import { BooleanValue, NumberValue, Schema } from '@coveo/bueno';
 import { type SearchBoxOptions as CoreSearchBoxOptions } from '../../core/search-box/headless-core-search-box-options.js';
 export type SearchBoxOptions = Pick<CoreSearchBoxOptions, 'id' | 'highlightOptions' | 'clearFilters'> & {
+    /**
+     * The number of query suggestions to request from the Coveo ML model (for example, `3`).
+     *
+     * When not specified, the API determines the number of suggestions returned.
+     */
+    numberOfSuggestions?: number;
     /**
      * 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.
@@ -10,10 +16,12 @@ export type SearchBoxOptions = Pick<CoreSearchBoxOptions, 'id' | 'highlightOptio
 };
 type DefaultSearchBoxOptions = Pick<SearchBoxOptions, 'clearFilters' | 'enableResults'>;
 export declare const defaultSearchBoxOptions: Required<DefaultSearchBoxOptions>;
+export type ResolvedSearchBoxOptions = Required<Omit<SearchBoxOptions, 'numberOfSuggestions'>> & Pick<SearchBoxOptions, 'numberOfSuggestions'>;
 export declare const searchBoxOptionDefinitions: {
     id: import("@coveo/bueno").StringValue<string>;
     highlightOptions: import("@coveo/bueno").RecordValue;
     clearFilters: BooleanValue;
+    numberOfSuggestions: NumberValue;
     enableResults: BooleanValue;
 };
 export declare const searchBoxOptionsSchema: Schema<Required<SearchBoxOptions>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/standalone-search-box/headless-standalone-search-box-options.d.ts

@@ -11,4 +11,5 @@ export interface StandaloneSearchBoxOptions extends SearchBoxOptions {
      */
     overwrite?: boolean;
 }
+export type ResolvedStandaloneSearchBoxOptions = Required<Omit<StandaloneSearchBoxOptions, 'numberOfSuggestions'>> & Pick<StandaloneSearchBoxOptions, 'numberOfSuggestions'>;
 export declare const standaloneSearchBoxSchema: Schema<Required<StandaloneSearchBoxOptions>>;

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

@@ -1,6 +1,6 @@
 import type { CoreEngine } from '../../../app/engine.js';
-import type { CustomAction, LegacySearchAction } from '../../../features/analytics/analytics-utils.js';
 import type { GeneratedAnswerFeedback } from '../../../features/generated-answer/generated-answer-analytics-actions.js';
+import type { GeneratedAnswerAnalyticsClient } from '../../../features/generated-answer/generated-answer-analytics-client.js';
 import type { GeneratedAnswerState } from '../../../features/generated-answer/generated-answer-state.js';
 import type { GeneratedResponseFormat } from '../../../features/generated-answer/generated-response-format.js';
 import { type Controller } from '../../controller/headless-controller.js';
@@ -101,30 +101,6 @@ export interface GeneratedAnswer extends Controller {
      */
     logCitationHover(citationId: string, citationHoverTimeMs: number, answerId: string): void;
 }
-export interface GeneratedAnswerAnalyticsClient {
-    /** @deprecated */
-    logLikeGeneratedAnswer(): CustomAction;
-    logLikeGeneratedAnswer(answerId?: string): CustomAction;
-    /** @deprecated */
-    logDislikeGeneratedAnswer(): CustomAction;
-    logDislikeGeneratedAnswer(answerId?: string): CustomAction;
-    logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
-    /** @deprecated */
-    logOpenGeneratedAnswerSource(citationId: string): CustomAction;
-    logOpenGeneratedAnswerSource(citationId: string, answerId?: string): CustomAction;
-    logOpenGeneratedAnswerFollowUpSource?(citationId: string, answerId: string): CustomAction;
-    /** @deprecated */
-    logHoverCitation(citationId: string, citationHoverTimeMs: number): CustomAction;
-    logHoverCitation(citationId: string, citationHoverTimeMs: number, answerId?: string): CustomAction;
-    logGeneratedAnswerShowAnswers: () => CustomAction;
-    logGeneratedAnswerHideAnswers: () => CustomAction;
-    /** @deprecated */
-    logCopyGeneratedAnswer(): CustomAction;
-    logCopyGeneratedAnswer(answerId?: string): CustomAction;
-    logRetryGeneratedAnswer: () => LegacySearchAction;
-    logGeneratedAnswerExpand: () => CustomAction;
-    logGeneratedAnswerCollapse: () => CustomAction;
-}
 export interface GeneratedAnswerPropsInitialState {
     initialState?: {
         /**

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

@@ -6,7 +6,8 @@ import type { SearchEngine } from '../../../app/search-engine/search-engine.js';
 import type { ClientThunkExtraArguments } from '../../../app/thunk-extra-arguments.js';
 import type { ConfigurationState } from '../../../features/configuration/configuration-state.js';
 import type { DebugSection, GeneratedAnswerSection, SearchSection } from '../../../state/state-sections.js';
-import { type GeneratedAnswer, type GeneratedAnswerAnalyticsClient, type GeneratedAnswerProps } from './headless-core-generated-answer.js';
+import { type GeneratedAnswer, type GeneratedAnswerProps } from './headless-core-generated-answer.js';
+import type { GeneratedAnswerAnalyticsClient } from '../../../features/generated-answer/generated-answer-analytics-client.js';
 interface SearchAPIGeneratedAnswer extends GeneratedAnswer {
 }
 interface SubscribeStateManager {

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/facet/headless-field-suggestions.d.ts

@@ -47,6 +47,7 @@ export interface FieldSuggestionsState {
  *
  * This controller is a wrapper around the basic facet controller search functionality, and thus exposes similar options and properties.
  *
+ * Example: [field-suggestions.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/field-suggestions.tsx)
  *
  * @group Controllers
  * @category FieldSuggestions

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

@@ -1,7 +1,8 @@
 import type { InsightEngine } from '../../../app/insight-engine/insight-engine.js';
 import type { SearchEngine } from '../../../app/search-engine/search-engine.js';
 import type { GeneratedAnswerFeedback } from '../../../features/generated-answer/generated-answer-analytics-actions.js';
-import { type GeneratedAnswer, type GeneratedAnswerAnalyticsClient, type GeneratedAnswerProps } from '../../core/generated-answer/headless-core-generated-answer.js';
+import { type GeneratedAnswer, type GeneratedAnswerProps } from '../../core/generated-answer/headless-core-generated-answer.js';
+import type { GeneratedAnswerAnalyticsClient } from '../../../features/generated-answer/generated-answer-analytics-client.js';
 interface AnswerApiGeneratedAnswer extends Omit<GeneratedAnswer, 'sendFeedback'> {
     /**
      * Resets the last answer.

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

@@ -2,7 +2,8 @@ import type { InsightEngine } from '../../../app/insight-engine/insight-engine.j
 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';
+import { type GeneratedAnswer, type GeneratedAnswerProps } from '../../core/generated-answer/headless-core-generated-answer.js';
+import type { GeneratedAnswerAnalyticsClient } from '../../../features/generated-answer/generated-answer-analytics-client.js';
 export interface GeneratedAnswerWithFollowUpsState extends GeneratedAnswerState {
     followUpAnswers: FollowUpAnswersState;
 }

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

@@ -21,6 +21,7 @@ type PreparableAnalyticsActionOptions<StateNeeded extends ConfigurationSection>
     preprocessRequest: PreprocessRequest | undefined;
     logger: Logger;
     getState(): StateNeeded;
+    disableBrowserPrivacySignals?: boolean;
 };
 export type AnalyticsAsyncThunk<StateNeeded extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> = AsyncThunk<void, void, AsyncThunkAnalyticsOptions<StateNeeded>> & UnknownAction;
 export declare function makeBasicNewSearchAnalyticsAction(actionCause: string, getState: () => StateNeededBySearchAnalyticsProvider): {

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

@@ -47,6 +47,7 @@ export declare const logCaseAttach: (result: Result) => ((arg?: undefined, confi
         preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
         logger: import("pino").Logger;
         getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+        disableBrowserPrivacySignals?: boolean;
     }) => Promise<{
         description?: import("coveo.analytics").EventDescription;
         action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;
@@ -99,6 +100,7 @@ export declare const logCaseDetach: (result: Result) => ((arg?: undefined, confi
         preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
         logger: import("pino").Logger;
         getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+        disableBrowserPrivacySignals?: boolean;
     }) => Promise<{
         description?: import("coveo.analytics").EventDescription;
         action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;
@@ -151,6 +153,7 @@ export declare const logCitationDocumentAttach: (citation: GeneratedAnswerCitati
         preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
         logger: import("pino").Logger;
         getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+        disableBrowserPrivacySignals?: boolean;
     }) => Promise<{
         description?: import("coveo.analytics").EventDescription;
         action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;
@@ -203,6 +206,7 @@ export declare const logCitationDocumentDetach: (citation: GeneratedAnswerCitati
         preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
         logger: import("pino").Logger;
         getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+        disableBrowserPrivacySignals?: boolean;
     }) => Promise<{
         description?: import("coveo.analytics").EventDescription;
         action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;

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

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

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

@@ -1,10 +1,10 @@
 import type { QuerySuggestSuccessResponse } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
-import type { CartSection, CommerceConfigurationSection, CommerceContextSection, CommerceQuerySection, QuerySetSection, VersionSection } from '../../../state/state-sections.js';
-import type { ClearQuerySuggestActionCreatorPayload, FetchQuerySuggestionsActionCreatorPayload, RegisterQuerySuggestActionCreatorPayload, SelectQuerySuggestionActionCreatorPayload } from '../../query-suggest/query-suggest-actions.js';
+import type { CartSection, CommerceConfigurationSection, CommerceContextSection, CommerceQuerySection, QuerySetSection, QuerySuggestionSection, VersionSection } from '../../../state/state-sections.js';
+import type { ClearQuerySuggestActionCreatorPayload, FetchQuerySuggestionsActionCreatorPayload, SelectQuerySuggestionActionCreatorPayload } from '../../query-suggest/query-suggest-actions.js';
 export type ClearQuerySuggestPayload = ClearQuerySuggestActionCreatorPayload;
 export declare const clearQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ClearQuerySuggestActionCreatorPayload], ClearQuerySuggestActionCreatorPayload, "commerce/querySuggest/clear", never, never>;
 export type FetchQuerySuggestionsPayload = FetchQuerySuggestionsActionCreatorPayload;
-export type StateNeededByQuerySuggest = CommerceConfigurationSection & CommerceContextSection & CartSection & QuerySetSection & CommerceQuerySection & Partial<VersionSection>;
+export type StateNeededByQuerySuggest = CommerceConfigurationSection & CommerceContextSection & CartSection & QuerySetSection & CommerceQuerySection & Partial<QuerySuggestionSection & VersionSection>;
 export interface FetchQuerySuggestionsThunkReturn extends FetchQuerySuggestionsActionCreatorPayload, QuerySuggestSuccessResponse {
     /**
      * The query for which query suggestions were retrieved.
@@ -21,7 +21,18 @@ export declare const fetchQuerySuggestions: import("@reduxjs/toolkit").AsyncThun
     fulfilledMeta?: unknown;
     rejectedMeta?: unknown;
 }>;
-export type RegisterQuerySuggestPayload = RegisterQuerySuggestActionCreatorPayload;
-export declare const registerQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterQuerySuggestActionCreatorPayload], RegisterQuerySuggestActionCreatorPayload, "commerce/querySuggest/register", never, never>;
+export interface RegisterQuerySuggestPayload {
+    /**
+     * A unique identifier for the query suggest entity (for example, `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
+     */
+    id: string;
+    /**
+     * The number of query suggestions to request from the API.
+     *
+     * When not specified, the API determines the default number of suggestions returned.
+     */
+    count?: number;
+}
+export declare const registerQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterQuerySuggestPayload], RegisterQuerySuggestPayload, "commerce/querySuggest/register", never, never>;
 export type SelectQuerySuggestionPayload = SelectQuerySuggestionActionCreatorPayload;
 export declare const selectQuerySuggestion: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SelectQuerySuggestionActionCreatorPayload], SelectQuerySuggestionActionCreatorPayload, "commerce/querySuggest/selectSuggestion", never, never>;

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

@@ -0,0 +1,38 @@
+import type { CustomAction, LegacySearchAction } from '../analytics/analytics-utils.js';
+import type { GeneratedAnswerFeedback } from './generated-answer-analytics-actions.js';
+/**
+ * Defines the analytics actions that a `GeneratedAnswer` controller needs to log
+ * analytics events for generated answers.
+ *
+ * This interface is implemented separately for each use case (e.g., `generatedAnswerAnalyticsClient`
+ * for Search, `generatedAnswerInsightAnalyticsClient` for Insight), and the appropriate
+ * implementation is registered as a thunk extra argument at engine-build time.
+ *
+ * @group Controllers
+ * @category GeneratedAnswer
+ */
+export interface GeneratedAnswerAnalyticsClient {
+    /** @deprecated */
+    logLikeGeneratedAnswer(): CustomAction;
+    logLikeGeneratedAnswer(answerId?: string): CustomAction;
+    /** @deprecated */
+    logDislikeGeneratedAnswer(): CustomAction;
+    logDislikeGeneratedAnswer(answerId?: string): CustomAction;
+    logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
+    /** @deprecated */
+    logOpenGeneratedAnswerSource(citationId: string): CustomAction;
+    logOpenGeneratedAnswerSource(citationId: string, answerId?: string): CustomAction;
+    logOpenGeneratedAnswerFollowUpSource?(citationId: string, answerId: string): CustomAction;
+    /** @deprecated */
+    logHoverCitation(citationId: string, citationHoverTimeMs: number): CustomAction;
+    logHoverCitation(citationId: string, citationHoverTimeMs: number, answerId?: string): CustomAction;
+    logGeneratedAnswerShowAnswers: () => CustomAction;
+    logGeneratedAnswerHideAnswers: () => CustomAction;
+    /** @deprecated */
+    logCopyGeneratedAnswer(): CustomAction;
+    logCopyGeneratedAnswer(answerId?: string): CustomAction;
+    logRetryGeneratedAnswer: () => LegacySearchAction;
+    logGeneratedAnswerExpand: () => CustomAction;
+    logGeneratedAnswerCollapse: () => CustomAction;
+    logGeneratedAnswerStreamEnd(answerGenerated: boolean, answerId?: string, answerTextIsEmpty?: boolean): CustomAction;
+}

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

@@ -6,7 +6,7 @@ export declare const logHoverCitation: (citationId: string, citationHoverTimeInM
 export declare const logLikeGeneratedAnswer: () => InsightAction;
 export declare const logDislikeGeneratedAnswer: () => InsightAction;
 export declare const logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => InsightAction;
-export declare const logGeneratedAnswerStreamEnd: (answerGenerated: boolean) => InsightAction;
+export declare const logGeneratedAnswerStreamEnd: (answerGenerated: boolean, answerId?: string, answerTextIsEmpty?: boolean) => InsightAction;
 export declare const logGeneratedAnswerResponseLinked: () => InsightAction;
 export declare const logGeneratedAnswerShowAnswers: () => InsightAction;
 export declare const logGeneratedAnswerHideAnswers: () => InsightAction;
@@ -17,7 +17,7 @@ export declare const generatedAnswerInsightAnalyticsClient: {
     logCopyGeneratedAnswer: () => InsightAction;
     logGeneratedAnswerHideAnswers: () => InsightAction;
     logGeneratedAnswerShowAnswers: () => InsightAction;
-    logGeneratedAnswerStreamEnd: (answerGenerated: boolean) => InsightAction;
+    logGeneratedAnswerStreamEnd: (answerGenerated: boolean, answerId?: string, answerTextIsEmpty?: boolean) => InsightAction;
     logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => InsightAction;
     logDislikeGeneratedAnswer: () => InsightAction;
     logLikeGeneratedAnswer: () => InsightAction;

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

@@ -46,6 +46,7 @@ export declare const logDocumentOpen: (result: Result) => ((arg?: undefined, con
         preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
         logger: import("pino").Logger;
         getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
+        disableBrowserPrivacySignals?: boolean;
     }) => Promise<{
         description?: import("coveo.analytics").EventDescription;
         action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;