coveo.analytics 2.30.55 → 2.31.0

package/dist/definitions/client/analytics.d.ts

@@ -16,6 +16,7 @@ export interface ClientOptions {
     beforeSendHooks: AnalyticsClientSendEventHook[];
     afterSendHooks: AnalyticsClientSendEventHook[];
     preprocessRequest?: PreprocessAnalyticsRequest;
+    disableBrowserPrivacySignals?: boolean;
 }
 export type AnalyticsClientSendEventHook = <TResult>(eventType: string, payload: any) => TResult | Promise<TResult>;
 export type EventTypeConfig = {
@@ -75,12 +76,12 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     getCurrentVisitorId(): Promise<string>;
     setCurrentVisitorId(visitorId: string): Promise<void>;
     setClientId(value: string, namespace?: string): Promise<void>;
-    getParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<any>;
+    getParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<VariableArgumentsPayload>;
     getPayload(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<any>;
     get currentVisitorId(): string;
     set currentVisitorId(visitorId: string);
     private extractClientIdFromLink;
-    resolveParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<any>;
+    resolveParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<VariableArgumentsPayload>;
     resolvePayloadForParameters(eventType: EventType | string, parameters: any): Promise<any>;
     makeEvent<TPreparedRequest, TCompleteRequest, TResponse extends AnyEventResponse>(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse>>;
     sendEvent(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<void | AnyEventResponse>;

package/dist/definitions/client/runtimeEnvironment.d.ts

@@ -14,7 +14,7 @@ export declare class BrowserRuntime implements IRuntimeEnvironment {
     client: AnalyticsFetchClient;
     private beaconClient;
     constructor(clientOptions: IAnalyticsClientOptions, getUnprocessedRequests: () => Array<BufferedRequest>);
-    getClientDependingOnEventType(eventType: EventType): AnalyticsFetchClient | AnalyticsBeaconClient;
+    getClientDependingOnEventType(eventType: EventType): AnalyticsBeaconClient | AnalyticsFetchClient;
 }
 export declare class NodeJSRuntime implements IRuntimeEnvironment {
     storage: WebStorage;

package/dist/definitions/donottrack.d.ts

@@ -1,2 +1,3 @@
 export declare function doNotTrack(): boolean;
+export declare function shouldDisableAnalyticsForPrivacy(disableBrowserPrivacySignals?: boolean): boolean;
 export default doNotTrack;

package/dist/definitions/react-native/index.d.ts

@@ -1,3 +1,3 @@
-export { ReactNativeRuntime, ReactNativeRuntimeOptions, ReactNativeStorage } from './react-native-runtime';
+export { ReactNativeRuntime, ReactNativeRuntimeOptions, ReactNativeStorage, } from './react-native-runtime';
 export * from '../coveoua/headless';
 import 'react-native-get-random-values';

package/dist/definitions/searchPage/searchPageClient.d.ts

@@ -1,6 +1,6 @@
 import { ClientOptions, AnalyticsClient } from '../client/analytics';
 import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } from '../events';
-import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata, SmartSnippetLinkMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerCitationMeta, GeneratedAnswerStreamEndMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerBaseMeta, GeneratedAnswerRephraseMeta, GeneratedAnswerFeedbackMetaV2, GeneratedAnswerCitationClickMeta, GeneratedAnswerInlineLinkMeta } from './searchPageEvents';
+import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata, SmartSnippetLinkMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerCitationMeta, GeneratedAnswerStreamEndMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerBaseMeta, GeneratedAnswerRephraseMeta, GeneratedAnswerFeedbackMetaV2, GeneratedAnswerCitationClickMeta, GeneratedAnswerInlineLinkMeta, GeneratedAnswerFollowupOpenSourceMeta } from './searchPageEvents';
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -196,6 +196,8 @@ export declare class CoveoSearchPageClient {
     logGeneratedAnswerOpenInlineLink(metadata: GeneratedAnswerInlineLinkMeta): Promise<void | CustomEventResponse>;
     makeGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta): Promise<EventBuilder<ClickEventResponse>>;
     logGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta): Promise<void | ClickEventResponse>;
+    makeGeneratedAnswerFollowupOpenSource(metadata: GeneratedAnswerFollowupOpenSourceMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logGeneratedAnswerFollowupOpenSource(metadata: GeneratedAnswerFollowupOpenSourceMeta): Promise<void | CustomEventResponse>;
     makeGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<EventBuilder<CustomEventResponse>>;
     logGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<void | CustomEventResponse>;
     makeGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;

package/dist/definitions/searchPage/searchPageEvents.d.ts

@@ -89,6 +89,7 @@ export declare enum SearchPageEvents {
     rephraseGeneratedAnswer = "rephraseGeneratedAnswer",
     generatedAnswerFeedbackSubmitV2 = "generatedAnswerFeedbackSubmitV2",
     generatedAnswerCitationClick = "generatedAnswerCitationClick",
+    generatedAnswerFollowupOpenSource = "generatedAnswerFollowupOpenSource",
     generatedAnswerCitationDocumentAttach = "generatedAnswerCitationDocumentAttach"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
@@ -199,6 +200,7 @@ export interface SmartSnippetDocumentIdentifier {
     contentIdValue: string;
 }
 export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid'>;
+export type PartialCitationInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid' | 'documentPosition'>;
 interface AnswerGeneratedWithAnswerAPI {
     answerAPIStreamId: string;
     generativeQuestionAnsweringId?: never;
@@ -237,6 +239,10 @@ export type GeneratedAnswerRephraseFormat = 'step' | 'bullet' | 'concise' | 'def
 export type GeneratedAnswerSourceHoverMeta = GeneratedAnswerCitationMeta & {
     citationHoverTimeMs: number;
 };
+export type GeneratedAnswerFollowupOpenSourceMeta = PartialCitationInformation & AnswerGeneratedWithAgent & {
+    citationId: string;
+    permanentId: string;
+};
 export type GeneratedAnswerRephraseMeta = GeneratedAnswerBaseMeta & {
     rephraseFormat: GeneratedAnswerRephraseFormat;
 };

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.30.55";
+export declare const libVersion = "2.31.0";