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, GeneratedAnswerFollowupOpenSourceMeta } from './searchPageEvents'; export interface SearchPageClientProvider { getBaseMetadata: () => Record; getSearchEventRequestPayload: () => Omit; getSearchUID: () => string; getPipeline: () => string; getOriginContext?: () => string; getOriginLevel1: () => string; getOriginLevel2: () => string; getOriginLevel3: () => string; getLanguage: () => string; getIsAnonymous: () => boolean; getFacetState?: () => FacetStateMetadata[]; getSplitTestRunName?: () => string | undefined; getSplitTestRunVersion?: () => string | undefined; getGeneratedAnswerMetadata?: () => Record; } export interface SearchPageClientOptions extends ClientOptions { enableAnalytics: boolean; } export type EventDescription = Pick; export interface EventBuilder { description: EventDescription; log(metadata: { searchUID: string; }): Promise; } export declare class CoveoSearchPageClient { private opts; private provider; coveoAnalyticsClient: AnalyticsClient; constructor(opts: Partial, provider: SearchPageClientProvider); disable(): void; enable(): void; makeInterfaceLoad(): Promise>; logInterfaceLoad(): Promise; makeRecommendationInterfaceLoad(): Promise>; logRecommendationInterfaceLoad(): Promise; makeRecommendation(): Promise>; logRecommendation(): Promise; makeRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise>; logRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise; makeStaticFilterClearAll(meta: StaticFilterMetadata): Promise>; logStaticFilterClearAll(meta: StaticFilterMetadata): Promise; makeStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise>; logStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise; makeStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise>; logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise; makeFetchMoreResults(): Promise>; logFetchMoreResults(): Promise; makeInterfaceChange(metadata: InterfaceChangeMetadata): Promise>; logInterfaceChange(metadata: InterfaceChangeMetadata): Promise; makeDidYouMeanAutomatic(): Promise>; logDidYouMeanAutomatic(): Promise; makeDidYouMeanClick(): Promise>; logDidYouMeanClick(): Promise; makeResultsSort(metadata: ResultsSortMetadata): Promise>; logResultsSort(metadata: ResultsSortMetadata): Promise; makeSearchboxSubmit(): Promise>; logSearchboxSubmit(): Promise; makeSearchboxClear(): Promise>; logSearchboxClear(): Promise; makeSearchboxAsYouType(): Promise>; logSearchboxAsYouType(): Promise; makeBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise>; logBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise; makeBreadcrumbResetAll(): Promise>; logBreadcrumbResetAll(): Promise; makeDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise>; logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise; makeDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise>; logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise; makeOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise>; logOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise; makeOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise>; logOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise; makeSearchFromLink(): Promise>; logSearchFromLink(): Promise; makeTriggerNotify(meta: TriggerNotifyMetadata): Promise>; logTriggerNotify(meta: TriggerNotifyMetadata): Promise; makeTriggerExecute(meta: TriggerExecuteMetadata): Promise>; logTriggerExecute(meta: TriggerExecuteMetadata): Promise; makeTriggerQuery(): Promise>; logTriggerQuery(): Promise; makeUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise>; logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise; makeTriggerRedirect(meta: TriggerRedirectMetadata): Promise>; logTriggerRedirect(meta: TriggerRedirectMetadata): Promise; makePagerResize(meta: PagerResizeMetadata): Promise>; logPagerResize(meta: PagerResizeMetadata): Promise; makePagerNumber(meta: PagerMetadata): Promise>; logPagerNumber(meta: PagerMetadata): Promise; makePagerNext(meta: PagerMetadata): Promise>; logPagerNext(meta: PagerMetadata): Promise; makePagerPrevious(meta: PagerMetadata): Promise>; logPagerPrevious(meta: PagerMetadata): Promise; makePagerScrolling(): Promise>; logPagerScrolling(): Promise; makeFacetClearAll(meta: FacetBaseMeta): Promise>; logFacetClearAll(meta: FacetBaseMeta): Promise; makeFacetSearch(meta: FacetBaseMeta): Promise>; logFacetSearch(meta: FacetBaseMeta): Promise; makeFacetSelect(meta: FacetMetadata): Promise>; logFacetSelect(meta: FacetMetadata): Promise; makeFacetDeselect(meta: FacetMetadata): Promise>; logFacetDeselect(meta: FacetMetadata): Promise; makeFacetExclude(meta: FacetMetadata): Promise>; logFacetExclude(meta: FacetMetadata): Promise; makeFacetUnexclude(meta: FacetMetadata): Promise>; logFacetUnexclude(meta: FacetMetadata): Promise; makeFacetSelectAll(meta: FacetBaseMeta): Promise>; logFacetSelectAll(meta: FacetBaseMeta): Promise; makeFacetUpdateSort(meta: FacetSortMeta): Promise>; logFacetUpdateSort(meta: FacetSortMeta): Promise; makeFacetShowMore(meta: FacetBaseMeta): Promise>; logFacetShowMore(meta: FacetBaseMeta): Promise; makeFacetShowLess(meta: FacetBaseMeta): Promise>; logFacetShowLess(meta: FacetBaseMeta): Promise; makeQueryError(meta: QueryErrorMeta): Promise>; logQueryError(meta: QueryErrorMeta): Promise; makeQueryErrorBack(): Promise>; logQueryErrorBack(): Promise; makeQueryErrorRetry(): Promise>; logQueryErrorRetry(): Promise; makeQueryErrorClear(): Promise>; logQueryErrorClear(): Promise; makeLikeSmartSnippet(): Promise>; logLikeSmartSnippet(): Promise; makeDislikeSmartSnippet(): Promise>; logDislikeSmartSnippet(): Promise; makeExpandSmartSnippet(): Promise>; logExpandSmartSnippet(): Promise; makeCollapseSmartSnippet(): Promise>; logCollapseSmartSnippet(): Promise; makeOpenSmartSnippetFeedbackModal(): Promise>; logOpenSmartSnippetFeedbackModal(): Promise; makeCloseSmartSnippetFeedbackModal(): Promise>; logCloseSmartSnippetFeedbackModal(): Promise; makeSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise>; logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise; makeExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise>; logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise; makeCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise>; logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise; private makeShowMoreSmartSnippetSuggestion; logShowMoreSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise; private makeShowLessSmartSnippetSuggestion; logShowLessSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise; makeOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise>; logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise; makeOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise>; makeCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise>; logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise; logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise; makeOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise>; logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise; makeOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise>; logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise; makeRecentQueryClick(): Promise>; logRecentQueryClick(): Promise; makeClearRecentQueries(): Promise>; logClearRecentQueries(): Promise; makeRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise>; logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise; makeClearRecentResults(): Promise>; logClearRecentResults(): Promise; makeNoResultsBack(): Promise>; logNoResultsBack(): Promise; makeShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise>; logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise; makeShowLessFoldedResults(): Promise>; logShowLessFoldedResults(): Promise; private makeEventDescription; makeCustomEvent(event: SearchPageEvents, metadata?: Record, eventType?: string): Promise>; logCustomEvent(event: SearchPageEvents, metadata?: Record, eventType?: string): Promise; makeCustomEventWithType(eventValue: string, eventType: string, metadata?: Record): Promise>; logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record): Promise; logSearchEvent(event: SearchPageEvents, metadata?: Record): Promise; makeSearchEvent(event: SearchPageEvents, metadata?: Record): Promise>; makeClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record): Promise>; logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record): Promise; private getBaseSearchEventRequest; private getBaseEventRequest; private getOrigins; private getClientId; private getSplitTestRun; makeLikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise>; logLikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise; makeDislikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise>; logDislikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise; makeOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise>; logOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise; makeGeneratedAnswerOpenInlineLink(metadata: GeneratedAnswerInlineLinkMeta): Promise>; logGeneratedAnswerOpenInlineLink(metadata: GeneratedAnswerInlineLinkMeta): Promise; makeGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta): Promise>; logGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta): Promise; makeGeneratedAnswerFollowupOpenSource(metadata: GeneratedAnswerFollowupOpenSourceMeta): Promise>; logGeneratedAnswerFollowupOpenSource(metadata: GeneratedAnswerFollowupOpenSourceMeta): Promise; makeGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise>; logGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise; makeGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise>; logGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise; makeGeneratedAnswerHideAnswers(metadata: GeneratedAnswerBaseMeta): Promise>; logGeneratedAnswerHideAnswers(metadata: GeneratedAnswerBaseMeta): Promise; makeGeneratedAnswerShowAnswers(metadata: GeneratedAnswerBaseMeta): Promise>; logGeneratedAnswerShowAnswers(metadata: GeneratedAnswerBaseMeta): Promise; makeGeneratedAnswerExpand(metadata: GeneratedAnswerBaseMeta): Promise>; logGeneratedAnswerExpand(metadata: GeneratedAnswerBaseMeta): Promise; makeGeneratedAnswerCollapse(metadata: GeneratedAnswerBaseMeta): Promise>; logGeneratedAnswerCollapse(metadata: GeneratedAnswerBaseMeta): Promise; makeGeneratedAnswerFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta): Promise>; logGeneratedAnswerFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta): Promise; makeGeneratedAnswerFeedbackSubmitV2(metadata: GeneratedAnswerBaseMeta): Promise>; logGeneratedAnswerFeedbackSubmitV2(meta: GeneratedAnswerFeedbackMetaV2): Promise; makeRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta): Promise>; logRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta): Promise; makeRetryGeneratedAnswer(): Promise>; logRetryGeneratedAnswer(): Promise; makeGeneratedAnswerStreamEnd(metadata: GeneratedAnswerStreamEndMeta): Promise>; logGeneratedAnswerStreamEnd(metadata: GeneratedAnswerStreamEndMeta): Promise; }