/// import type { AggregationFunction } from '@aws-sdk/client-quicksight'; import type { ColumnIdentifier } from '@aws-sdk/client-quicksight'; import type { DateDimensionField } from '@aws-sdk/client-quicksight'; import type { FilterGroup } from '@aws-sdk/client-quicksight'; import type { ThemeConfiguration } from '@aws-sdk/client-quicksight'; import type { VisualCustomAction } from '@aws-sdk/client-quicksight'; import type { VisualCustomActionOperation } from '@aws-sdk/client-quicksight'; export declare type ActionOperation = { CallbackOperation: CallbackOperation; } & VisualCustomActionOperation; export declare interface AgentOptions { /** * The chat will be locked to use the specified chat agent. */ fixedAgentId?: string; } export declare interface AttributionOptions { overlayContent?: boolean; } export declare interface BaseContentOptions { onMessage?: EventListener_2; } export declare abstract class BaseExperience> { protected abstract experience: Experience; protected abstract internalExperience: InternalExperience; protected abstract experienceId: string; protected abstract experienceFrame: ExperienceFrame; protected readonly frameOptions: FrameOptions; protected readonly contentOptions: ExperienceContentOptions; protected readonly controlOptions: ControlOptions; protected readonly experienceIdentifiers: Set; protected logger?: LogProvider; protected constructor(frameOptions: FrameOptions, contentOptions: ExperienceContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set); static getExperienceIdentifier: (experience: InternalExperiences) => string; send: (messageEvent: EmbeddingMessageEvent) => Promise>; addEventListener: (eventName: MessageEventName, listener: EventListener_2) => { remove: () => EventManager; }; setLogProvider: (logProvider: LogProvider) => this; protected getInternalExperienceInfo: (experience: EmbeddingExperience) => InternalExperienceInfo; protected transformContentOptions: (filteredOptions: TCO, unrecognizedContentOptions: object) => TCO; protected warnUnrecognizedContentOptions: (unrecognizedProperties: string[]) => void; protected abstract extractExperienceFromUrl: (url: string) => Experience; private validateFrameOptions; } export declare abstract class BaseExperienceFrame { protected readonly frameOptions: FrameOptions; protected readonly contentOptions: ExperienceContentOptions; protected readonly controlOptions: ControlOptions; protected readonly transformedContentOptions: TransformedExperienceContentOptions; protected readonly experienceId: string; protected readonly internalExperience: InternalExperience; protected readonly onChange: EventListener_2; protected url: string; private readonly MESSAGE_RESPONSE_TIMEOUT; iframe: EmbeddingIFrameElement | null; container: HTMLElement; onMessage: EventListener_2; timeoutInstance?: NodeJS.Timeout; protected constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: ExperienceContentOptions, transformedContentOptions: TransformedExperienceContentOptions, internalExperience: InternalExperience, experienceIdentifier: string, interceptMessage?: EventListener_2); send: (messageEvent: TargetedMessageEvent) => Promise | DataResponse>; buildParameterString: (parameters?: ParametersAsObject) => string; buildQueryString: (options: Omit & Pick) => string; createExperienceIframe: () => void; addInternalEventListener: (eventName: MessageEventName, listener: EventListener_2) => { remove: () => EventManager; }; private validateBaseUrl; private setTimeoutInstance; private onLoadHandler; private getContainer; private decorateOnChange; private decorateOnMessage; private initializeMutationObserver; protected abstract buildExperienceUrl: (baseUrl: string) => string; } export declare type BinDatapointRawValue = { Min: number | null; Max: number | null; IsMaxInclusive: boolean; }; export declare const CALCULATED_METRIC_COLUMN_TYPE: { readonly INTEGER: null; readonly STRING: null; readonly DECIMAL: null; readonly DATETIME: null; }; export declare interface CallbackOperation { EmbeddingMessage: object; } export declare class ChangeEvent extends EmbeddingEvent { eventLevel: ChangeEventLevel; constructor(eventName: EventName, eventLevel: ChangeEventLevel, message?: EventMessageValue, data?: EventData); } export declare const ChangeEventLevel: { readonly ERROR: "ERROR"; readonly INFO: "INFO"; readonly WARN: "WARN"; }; export declare type ChangeEventLevel = (typeof ChangeEventLevel)[keyof typeof ChangeEventLevel]; export declare const ChangeEventName: { readonly UNRECOGNIZED_CONTENT_OPTIONS: "UNRECOGNIZED_CONTENT_OPTIONS"; readonly UNRECOGNIZED_FRAME_OPTIONS: "UNRECOGNIZED_FRAME_OPTIONS"; readonly UNRECOGNIZED_EVENT_TARGET: "UNRECOGNIZED_EVENT_TARGET"; readonly FRAME_NOT_CREATED: "FRAME_NOT_CREATED"; readonly NO_BODY: "NO_BODY"; readonly NO_CONTAINER: "NO_CONTAINER"; readonly INVALID_CONTAINER: "INVALID_CONTAINER"; readonly NO_URL: "NO_URL"; readonly INVALID_URL: "INVALID_URL"; readonly NO_FRAME_OPTIONS: "NO_FRAME_OPTIONS"; readonly INVALID_FRAME_OPTIONS: "INVALID_FRAME_OPTIONS"; readonly FRAME_STARTED: "FRAME_STARTED"; readonly FRAME_MOUNTED: "FRAME_MOUNTED"; readonly FRAME_LOADED: "FRAME_LOADED"; readonly FRAME_REMOVED: "FRAME_REMOVED"; }; export declare type ChangeEventName = (typeof ChangeEventName)[keyof typeof ChangeEventName]; export declare type ChangeMessageEvents = ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent | ChangeEvent; export declare type CleanUpCallback = () => void; export declare interface ConsoleContentOptions extends BaseContentOptions { locale?: string; toolbarOptions?: ConsoleToolbarOptions; } export declare class ConsoleExperience extends BaseExperience { protected experience: IConsoleExperience; protected internalExperience: InternalConsoleExperience; protected experienceId: string; protected experienceFrame: ConsoleExperienceFrame; protected currentPage: string | undefined; constructor(frameOptions: FrameOptions, contentOptions: ConsoleContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set); createSharedView: () => Promise; toggleExecutiveSummaryPane: () => Promise; openDataQnAPane: () => Promise; openBuildVisualPane: () => Promise; buildStoryFromDashboard: () => Promise; private interceptMessage; protected extractExperienceFromUrl: (url: string) => IConsoleExperience; private transformConsoleContentOptions; } export declare class ConsoleExperienceFrame extends BaseExperienceFrame { constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: ConsoleContentOptions, transformedContentOptions: TransformedConsoleContentOptions, internalExperience: InternalConsoleExperience, experienceIdentifier: string, interceptMessage?: EventListener_2); buildExperienceUrl: (baseUrl: string) => string; } export declare interface ConsoleToolbarOptions { executiveSummary?: boolean | ToolbarOption; dataQnA?: boolean | ToolbarOption; buildVisual?: boolean | ToolbarOption; buildStory?: boolean | ToolbarOption; } export declare type ContentOptions = VisualContentOptions | DashboardContentOptions | QSearchContentOptions | ConsoleContentOptions | ControlContentOptions | GenerativeQnAContentOptions | QuickChatContentOptions; export declare type ControlContentOptions = BaseContentOptions; export declare class ControlExperience { static FRAME_TIMEOUT: number; private readonly container; private readonly urlInfo; private readonly internalExperience; private readonly eventManager; private readonly onChange?; private readonly experience; private readonly logger?; private readonly controlExperienceFrame; constructor(container: HTMLBodyElement, controlOptions: ControlOptions, onChange?: EventListener_2, logger?: LogProvider); send: (messageEvent: TargetedMessageEvent) => Promise | DataResponse>; controlFrameMessageListener: (event: MessageEvent) => void; private sendAcknowledgment; private getControlExperienceId; private getControlExperienceBaseUrl; private isMessageEvent; } export declare class ControlExperienceFrame extends BaseExperienceFrame { constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: BaseContentOptions, transformedContentOptions: object, internalExperience: InternalControlExperience, experienceIdentifier: string, interceptMessage?: EventListener_2); buildExperienceUrl: (baseUrl: string) => string; } export declare type ControlOptions = { eventManager: EventManager; contextId: string; areCookiesDisabled?: boolean; urlInfo: UrlInfo; timeout?: number; sendToControlFrame?: (messageEvent: TargetedMessageEvent) => Promise; onChange?: EventListener; }; export declare const createEmbeddingContext: (frameOptions?: EmbeddingContextFrameOptions) => Promise; export declare type CreatePostRequestOptions = { src: string; container: HTMLElement; target: string; payload: { [key: string]: string; }; }; export declare interface DashboardContentOptions extends BaseContentOptions { parameters?: Parameter[]; locale?: string; attributionOptions?: AttributionOptions; toolbarOptions?: ToolbarOptions; sheetOptions?: SheetOptions; themeOptions?: ThemeOptions; viewId?: string; } export declare class DashboardExperience extends BaseExperience { protected readonly experience: IDashboardExperience; protected readonly internalExperience: InternalDashboardExperience; protected readonly experienceFrame: DashboardExperienceFrame; protected readonly experienceId: string; constructor(frameOptions: FrameOptions, contentOptions: DashboardContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set); initiatePrint: () => Promise; undo: () => Promise; redo: () => Promise; toggleExecutiveSummaryPane: () => Promise; toggleBookmarksPane: () => Promise; toggleThresholdAlertsPane: () => Promise; toggleSchedulingPane: () => Promise; toggleRecentSnapshotsPane: () => Promise; getParameters: () => Promise; getSheets: () => Promise; addFilterGroups: (filterGroups: FilterGroup[]) => Promise; updateFilterGroups: (filterGroups: FilterGroup[]) => Promise; removeFilterGroups: (filterGroups: FilterGroup[] | string[]) => Promise; getFilterGroupsForSheet: (sheetId: string) => Promise; getFilterGroupsForVisual: (sheetId: string, visualId: string) => Promise; getVisualActions: (sheetId: string, visualId: string) => Promise; addVisualActions: (sheetId: string, visualId: string, actions: VisualAction[]) => Promise; setVisualActions: (sheetId: string, visualId: string, actions: VisualAction[]) => Promise; getSelectedSheetId: () => Promise; setSelectedSheetId: (sheetId: string) => Promise; setTheme: (themeArn: string) => Promise; navigateToDashboard: (dashboardId: string, navigateToDashboardOptions?: NavigateToDashboardOptions) => Promise; removeVisualActions: (sheetId: string, visualId: string, actions: VisualAction[]) => Promise; getSheetVisuals: (sheetId: string) => Promise; setParameters: (parameters: Parameter[]) => Promise; reset: () => Promise; setThemeOverride: (themeOverride: ThemeConfiguration) => Promise; setPreloadThemes: (preloadThemes: string[]) => Promise; createSharedView: () => Promise; protected extractExperienceFromUrl: (url: string) => IDashboardExperience; private interceptMessage; private transformDashboardContentOptions; } export declare class DashboardExperienceFrame extends BaseExperienceFrame { constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: DashboardContentOptions, transformedContentOptions: TransformedDashboardContentOptions, internalExperience: InternalDashboardExperience, experienceIdentifier: string, interceptMessage?: EventListener_2); buildExperienceUrl: (baseUrl: string) => string; } export declare interface Datapoint { FormattedValues: DatapointFormattedValue[]; RawValues: DatapointRawValue[]; Columns: DatapointColumn[]; SelectedColumnIndex?: number; } export declare interface DatapointColumn { Metric?: MetricColumn; Field?: FieldColumn; } export declare interface DatapointFormattedValue { Value: string; Special?: keyof typeof SPECIAL_DATAPOINT_VALUE_TYPES; } export declare interface DatapointRawValue { String?: string; Integer?: number; Decimal?: number; Date?: Date; Bin?: BinDatapointRawValue; } export declare class DataResponse implements ResponseMessage { success: boolean; message?: EventMessageValue; constructor(message?: EventMessageValue); } /** * Temporary abstraction for customer provided logger * */ export declare class DefaultLogger implements LogProvider { log: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void; }; warn: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void; }; error: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void; }; debug: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void; }; info: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void; }; } /** * The embedding context creates an additional zero-pixel iframe and appends it into the body element on the page to centralize communication between the SDK and the embedded QuickSight content */ export declare class EmbeddingContext implements IEmbeddingContext { private readonly experienceIdentifiers; private readonly eventManager; private readonly contextId; private readonly contextOnChange; private controlOptions?; private readonly logger; constructor(contextFrameOptions: EmbeddingContextFrameOptions); embedVisual: (frameOptions: FrameOptions, contentOptions?: VisualContentOptions) => Promise; embedDashboard: (frameOptions: FrameOptions, contentOptions?: DashboardContentOptions) => Promise; embedConsole: (frameOptions: FrameOptions, contentOptions?: ConsoleContentOptions) => Promise; embedQSearchBar: (frameOptions: FrameOptions, contentOptions?: QSearchContentOptions) => Promise; embedGenerativeQnA: (frameOptions: FrameOptions, contentOptions?: GenerativeQnAContentOptions) => Promise; embedQuickChat: (frameOptions: FrameOptions, contentOptions?: QuickChatContentOptions) => Promise; private validateFrameOptions; private buildControlOptions; private onChange; private getControlUrlInfo; private getBodyElement; } export declare type EmbeddingContextFrameOptions = { onChange?: EventListener_2; }; export declare abstract class EmbeddingEvent { eventName: EventName; message?: EventMessageValue; data?: EventData; eventTarget?: InternalExperiences; protected constructor(eventName: EventName, message?: EventMessageValue, data?: EventData); } export declare type EmbeddingEvents = ChangeMessageEvents | GetterMessageEvents | SetterMessageEvents | InfoMessageEvents | InvokerMessageEvents; export declare interface EmbeddingIFrameElement extends HTMLIFrameElement { loading: string; } export declare class EmbeddingMessageEvent extends EmbeddingEvent { eventName: EventName; constructor(eventName: EventName, message?: EventMessageValue, data?: EventData); } export declare const ErrorChangeEventName: { readonly FRAME_NOT_CREATED: "FRAME_NOT_CREATED"; readonly NO_BODY: "NO_BODY"; readonly NO_CONTAINER: "NO_CONTAINER"; readonly INVALID_CONTAINER: "INVALID_CONTAINER"; readonly NO_URL: "NO_URL"; readonly INVALID_URL: "INVALID_URL"; readonly NO_FRAME_OPTIONS: "NO_FRAME_OPTIONS"; readonly INVALID_FRAME_OPTIONS: "INVALID_FRAME_OPTIONS"; }; export declare type ErrorChangeEventName = (typeof ErrorChangeEventName)[keyof typeof ErrorChangeEventName]; export declare class ErrorResponse implements ResponseMessage { success: boolean; error?: string; message?: EventMessageValue; errorCode: string; constructor(errorResponse: ErrorResponse); } export declare type EventData = Record; declare type EventListener_2 = (event: EmbeddingEvents, metadata?: ExperienceFrameMetadata) => void; export { EventListener_2 as EventListener } /** * Manages the event listeners for the experiences within an embedding context */ export declare class EventManager { private eventListeners; private cleanUpCallbacks; constructor(); addEventListener: (experienceId: ExperienceIdentifier, listener: EventListener_2, cleanUp?: boolean) => this; invokeEventListener: (experienceId: ExperienceIdentifier, event: EmbeddingEvents) => this; removeEventListener: (experienceId: ExperienceIdentifier, listener: EventListener_2) => this; addEventListenerForCleanup: (experienceId: ExperienceIdentifier, cleanupCallback: CleanUpCallback) => void; cleanUpCallbacksForExperience: (experienceId: ExperienceIdentifier) => void; } export declare type EventMessageValues = string | string[] | { height?: string; } | Visual[] | number | EmbeddingIFrameElement | InternalExperiences | Record | Parameter[] | VisualAction[] | FilterGroup[] | Sheet[] | undefined | { success?: boolean; } | ThemeConfiguration; export declare type EventNames = MessageEventName | ChangeEventName; export declare type ExperienceFrameMetadata = { frame: EmbeddingIFrameElement | null; }; export declare type ExperienceIdentifier = string; export declare type Experiences = IConsoleExperience | IContextExperience | IControlExperience | IVisualExperience | IDashboardExperience | IQSearchExperience | IGenerativeQnAExperience | IQuickChatExperience; export declare const ExperienceType: { readonly CONSOLE: "CONSOLE"; readonly CONTEXT: "CONTEXT"; readonly CONTROL: "CONTROL"; readonly VISUAL: "VISUAL"; readonly DASHBOARD: "DASHBOARD"; readonly QSEARCH: "QSEARCH"; readonly GENERATIVEQNA: "QSEARCH"; readonly QUICKCHAT: "QUICKCHAT"; }; export declare type ExperienceType = (typeof ExperienceType)[keyof typeof ExperienceType]; export declare interface ExportToolbarOption extends ToolbarOption { print?: boolean; } export declare interface FieldColumn { Integer?: { Column: ColumnIdentifier; }; Decimal?: { Column: ColumnIdentifier; }; String?: { Column: ColumnIdentifier; }; DateTime?: { Column: ColumnIdentifier; TimeGranularity: DateDimensionField['DateGranularity']; }; } export declare interface FooterOptions { /** * Whether the brand attribution statement will be shown. */ showBrandAttribution?: boolean; /** * Whether the usage policy link will be shown. */ showUsagePolicy?: boolean; } export declare type FrameOptions = { url: string; container: string | HTMLElement; width?: string; height?: string; resizeHeightOnSizeChangedEvent?: boolean; withIframePlaceholder?: boolean | HTMLElement; className?: string; onChange?: EventListener_2; framePermissions?: FramePermissionOptions; }; export declare interface FramePermissionOptions { clipboardRead?: boolean; clipboardWrite?: boolean; } export declare type FrameStyles = { position: string; top: string; left: string; zIndex: string; width: string; height: string; }; export declare interface GenerativeQnAContentOptions extends BaseContentOptions { showTopicName?: boolean; showPinboard?: boolean; showSearchBar?: boolean; showInterpretedAs?: boolean; showFeedback?: boolean; showGeneratedNarrative?: boolean; showDidYouMean?: boolean; showComplementaryVisuals?: boolean; showQBusinessInsights?: boolean; showSeeWhy?: boolean; allowTopicSelection?: boolean; allowFullscreen?: boolean; allowReturn?: boolean; searchPlaceholderText?: string; panelOptions?: GenerativeQnAPanelOptions; themeOptions?: QThemeOptions; initialQuestionId?: string; initialAnswerId?: string; } export declare class GenerativeQnAExperience extends InternalQBaseExperience { protected experience: IGenerativeQnAExperience; protected internalExperience: InternalGenerativeQnAExperience; protected experienceFrame: GenerativeQnAExperienceFrame; protected experienceId: string; protected frameStyles?: FrameStyles; static readonly TEXT_PROPERTY_MAX_LENGTH = 200; constructor(frameOptions: FrameOptions, contentOptions: GenerativeQnAContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set); protected extractExperienceFromUrl: (url: string) => IGenerativeQnAExperience; private interceptMessage; private transformGenerativeQnAContentOptions; private checkMaxLength; } export declare class GenerativeQnAExperienceFrame extends BaseExperienceFrame { constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: GenerativeQnAContentOptions, transformedContentOptions: TransformedGenerativeQnAContentOptions, internalExperience: InternalGenerativeQnAExperience, experienceIdentifier: string, interceptMessage?: EventListener_2); buildExperienceUrl: (baseUrl: string) => string; } export declare type GenerativeQnAFullPanelOptions = { panelType: typeof GenerativeQnAPanelType.FULL; title?: string; showQIcon?: boolean; }; export declare type GenerativeQnAPanelOptions = GenerativeQnAFullPanelOptions | GenerativeQnASearchBarOptions; export declare const GenerativeQnAPanelType: { readonly FULL: "FULL"; readonly SEARCH_BAR: "SEARCH_BAR"; }; export declare type GenerativeQnASearchBarOptions = { panelType: typeof GenerativeQnAPanelType.SEARCH_BAR; focusedHeight?: string; expandedHeight?: string; }; export declare const GetterMessageEventName: { readonly GET_PARAMETERS: "GET_PARAMETERS"; readonly GET_SHEETS: "GET_SHEETS"; readonly GET_SHEET_VISUALS: "GET_SHEET_VISUALS"; readonly GET_VISUAL_ACTIONS: "GET_VISUAL_ACTIONS"; readonly GET_SELECTED_SHEET_ID: "GET_SELECTED_SHEET_ID"; readonly GET_FILTER_GROUPS_FOR_SHEET: "GET_FILTER_GROUPS_FOR_SHEET"; readonly GET_FILTER_GROUPS_FOR_VISUAL: "GET_FILTER_GROUPS_FOR_VISUAL"; }; export declare type GetterMessageEventName = (typeof GetterMessageEventName)[keyof typeof GetterMessageEventName]; export declare type GetterMessageEvents = EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent; export declare interface IBaseExperience { experienceType: ExperienceType; discriminator?: number; } export declare interface IConsoleExperience extends IBaseExperience { experienceType: typeof ExperienceType.CONSOLE; } export declare interface IContextExperience extends IBaseExperience { experienceType: typeof ExperienceType.CONTEXT; } export declare interface IControlExperience extends IBaseExperience { experienceType: typeof ExperienceType.CONTROL; } export declare interface IDashboardExperience extends IBaseExperience { experienceType: typeof ExperienceType.DASHBOARD; dashboardId: string; } export declare type IEmbeddingContext = { embedDashboard: (frameOptions: FrameOptions, contentOptions?: DashboardContentOptions) => Promise; embedVisual: (frameOptions: FrameOptions, contentOptions?: VisualContentOptions) => Promise; embedQSearchBar: (frameOptions: FrameOptions, contentOptions?: QSearchContentOptions) => Promise; embedConsole: (frameOptions: FrameOptions, contentOptions?: ConsoleContentOptions) => Promise; }; export declare class Iframe { static IFRAME_CLASS_NAME: string; private readonly iframeName; private readonly width; private readonly height; private readonly loading; private readonly container; private readonly payload; private readonly src; private readonly onLoad; private readonly framePermissions; private readonly iframe; private iframePlaceholder?; private classNames; private postRequest?; constructor(options: IframeOptions); getIframe: () => EmbeddingIFrameElement; private createIframePlaceholder; private createIframe; private onLoadLocal; private createPostRequest; private createSvgElement; private createLoaderSVG; } export declare type IframeOptions = { id: string; src: string; container: HTMLElement; width?: string; height?: string; onLoad?: (event: Event) => void; loading?: 'eager' | 'lazy'; withIframePlaceholder?: boolean | HTMLElement; payload?: { [key: string]: string; }; className?: string; framePermissions?: FramePermissionOptions; }; export declare interface IGenerativeQnAExperience extends IBaseExperience { experienceType: typeof ExperienceType.GENERATIVEQNA; } export declare const InfoChangeEventName: { readonly FRAME_STARTED: "FRAME_STARTED"; readonly FRAME_MOUNTED: "FRAME_MOUNTED"; readonly FRAME_LOADED: "FRAME_LOADED"; readonly FRAME_REMOVED: "FRAME_REMOVED"; }; export declare type InfoChangeEventName = (typeof InfoChangeEventName)[keyof typeof InfoChangeEventName]; export declare const InfoMessageEventName: { readonly CALLBACK_OPERATION_INVOKED: "CALLBACK_OPERATION_INVOKED"; readonly CONTENT_LOADED: "CONTENT_LOADED"; readonly EXPERIENCE_INITIALIZED: "EXPERIENCE_INITIALIZED"; readonly ERROR_OCCURRED: "ERROR_OCCURRED"; readonly SIZE_CHANGED: "SIZE_CHANGED"; readonly PARAMETERS_CHANGED: "PARAMETERS_CHANGED"; readonly SELECTED_SHEET_CHANGED: "SELECTED_SHEET_CHANGED"; readonly MODAL_OPENED: "MODAL_OPENED"; readonly Q_SEARCH_CLOSED: "Q_SEARCH_CLOSED"; readonly Q_SEARCH_OPENED: "Q_SEARCH_OPENED"; readonly Q_SEARCH_FOCUSED: "Q_SEARCH_FOCUSED"; readonly Q_SEARCH_SIZE_CHANGED: "Q_SEARCH_SIZE_CHANGED"; readonly Q_SEARCH_ENTERED_FULLSCREEN: "Q_SEARCH_ENTERED_FULLSCREEN"; readonly Q_SEARCH_EXITED_FULLSCREEN: "Q_SEARCH_EXITED_FULLSCREEN"; readonly Q_PANEL_ENTERED_FULLSCREEN: "Q_PANEL_ENTERED_FULLSCREEN"; readonly Q_PANEL_EXITED_FULLSCREEN: "Q_PANEL_EXITED_FULLSCREEN"; readonly PAGE_NAVIGATION: "PAGE_NAVIGATION"; readonly PARAMETERS_LOADED: "PARAMETERS_LOADED"; }; export declare type InfoMessageEventName = (typeof InfoMessageEventName)[keyof typeof InfoMessageEventName]; export declare type InfoMessageEvents = EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | TargetedMessageEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent | EmbeddingEvent; export declare interface InternalConsoleExperience extends IConsoleExperience { contextId: string; } export declare interface InternalContextExperience extends IContextExperience { contextId: string; } export declare interface InternalControlExperience extends IControlExperience { contextId: string; } export declare interface InternalDashboardExperience extends IDashboardExperience { contextId: string; } export declare interface InternalExperienceInfo { experienceIdentifier: string; internalExperience: InternalExperience; } export declare type InternalExperiences = InternalConsoleExperience | InternalContextExperience | InternalControlExperience | InternalVisualExperience | InternalDashboardExperience | InternalQSearchExperience | InternalGenerativeQnAExperience | InternalQuickChatExperience; export declare interface InternalGenerativeQnAExperience extends IGenerativeQnAExperience { contextId: string; } /** * Internal base experience for embedded Q, * containing shared functionality between q-search-bar and generative-qna experience types. */ export declare abstract class InternalQBaseExperience> extends BaseExperience { static readonly MAX_Z_INDEX = "2147483647"; protected frameStyles?: FrameStyles; close: () => Promise; setQuestion: (question: string) => Promise; protected trackOutsideClicks: () => void; protected enterFullScreen: (metadata: ExperienceFrameMetadata | undefined) => void; protected exitFullScreen: (metadata: ExperienceFrameMetadata | undefined) => void; } export declare interface InternalQSearchExperience extends IQSearchExperience { contextId: string; } export declare interface InternalQuickChatExperience extends IQuickChatExperience { contextId: string; } export declare interface InternalVisualExperience extends IVisualExperience { contextId: string; } export declare const InvokerMessageEventName: { readonly ACKNOWLEDGE: "ACKNOWLEDGE"; readonly INITIATE_PRINT: "INITIATE_PRINT"; readonly NAVIGATE_TO_DASHBOARD: "NAVIGATE_TO_DASHBOARD"; readonly CLOSE_Q_SEARCH: "CLOSE_Q_SEARCH"; readonly UNDO: "UNDO"; readonly REDO: "REDO"; readonly RESET: "RESET"; readonly TOGGLE_EXECUTIVE_SUMMARY_PANE: "TOGGLE_EXECUTIVE_SUMMARY_PANE"; readonly OPEN_BUILD_VISUAL_PANE: "OPEN_BUILD_VISUAL_PANE"; readonly OPEN_DATA_QNA_PANE: "OPEN_DATA_QNA_PANE"; readonly TOGGLE_BOOKMARKS_PANE: "TOGGLE_BOOKMARKS_PANE"; readonly TOGGLE_THRESHOLD_ALERTS_PANE: "TOGGLE_THRESHOLD_ALERTS_PANE"; readonly TOGGLE_SCHEDULING_PANE: "TOGGLE_SCHEDULING_PANE"; readonly TOGGLE_RECENT_SNAPSHOTS_PANE: "TOGGLE_RECENT_SNAPSHOTS_PANE"; readonly IMPORT_OBJECTS: "IMPORT_OBJECTS"; readonly OPEN_BUILD_STORY_PANE: "OPEN_BUILD_STORY_PANE"; readonly SEND_PROMPT: "SEND_PROMPT"; }; export declare type InvokerMessageEventName = (typeof InvokerMessageEventName)[keyof typeof InvokerMessageEventName]; export declare type InvokerMessageEvents = TargetedMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent; export declare interface IQSearchExperience extends IBaseExperience { experienceType: typeof ExperienceType.QSEARCH; } export declare interface IQuickChatExperience extends IBaseExperience { experienceType: typeof ExperienceType.QUICKCHAT; } export declare interface IVisualExperience extends IBaseExperience { experienceType: typeof ExperienceType.VISUAL; dashboardId: string; sheetId: string; visualId: string; } export declare interface LogProvider { log: typeof console.log; warn: typeof console.warn; error: typeof console.error; debug: typeof console.debug; info: typeof console.info; } export declare const MessageEventName: { readonly ACKNOWLEDGE: "ACKNOWLEDGE"; readonly INITIATE_PRINT: "INITIATE_PRINT"; readonly NAVIGATE_TO_DASHBOARD: "NAVIGATE_TO_DASHBOARD"; readonly CLOSE_Q_SEARCH: "CLOSE_Q_SEARCH"; readonly UNDO: "UNDO"; readonly REDO: "REDO"; readonly RESET: "RESET"; readonly TOGGLE_EXECUTIVE_SUMMARY_PANE: "TOGGLE_EXECUTIVE_SUMMARY_PANE"; readonly OPEN_BUILD_VISUAL_PANE: "OPEN_BUILD_VISUAL_PANE"; readonly OPEN_DATA_QNA_PANE: "OPEN_DATA_QNA_PANE"; readonly TOGGLE_BOOKMARKS_PANE: "TOGGLE_BOOKMARKS_PANE"; readonly TOGGLE_THRESHOLD_ALERTS_PANE: "TOGGLE_THRESHOLD_ALERTS_PANE"; readonly TOGGLE_SCHEDULING_PANE: "TOGGLE_SCHEDULING_PANE"; readonly TOGGLE_RECENT_SNAPSHOTS_PANE: "TOGGLE_RECENT_SNAPSHOTS_PANE"; readonly IMPORT_OBJECTS: "IMPORT_OBJECTS"; readonly OPEN_BUILD_STORY_PANE: "OPEN_BUILD_STORY_PANE"; readonly SEND_PROMPT: "SEND_PROMPT"; readonly GET_PARAMETERS: "GET_PARAMETERS"; readonly GET_SHEETS: "GET_SHEETS"; readonly GET_SHEET_VISUALS: "GET_SHEET_VISUALS"; readonly GET_VISUAL_ACTIONS: "GET_VISUAL_ACTIONS"; readonly GET_SELECTED_SHEET_ID: "GET_SELECTED_SHEET_ID"; readonly GET_FILTER_GROUPS_FOR_SHEET: "GET_FILTER_GROUPS_FOR_SHEET"; readonly GET_FILTER_GROUPS_FOR_VISUAL: "GET_FILTER_GROUPS_FOR_VISUAL"; readonly SET_PARAMETERS: "SET_PARAMETERS"; readonly SET_SELECTED_SHEET_ID: "SET_SELECTED_SHEET_ID"; readonly SET_Q_SEARCH_QUESTION: "SET_Q_SEARCH_QUESTION"; readonly SET_VISUAL_ACTIONS: "SET_VISUAL_ACTIONS"; readonly SET_THEME: "SET_THEME"; readonly ADD_FILTER_GROUPS: "ADD_FILTER_GROUPS"; readonly UPDATE_FILTER_GROUPS: "UPDATE_FILTER_GROUPS"; readonly REMOVE_FILTER_GROUPS: "REMOVE_FILTER_GROUPS"; readonly ADD_VISUAL_ACTIONS: "ADD_VISUAL_ACTIONS"; readonly REMOVE_VISUAL_ACTIONS: "REMOVE_VISUAL_ACTIONS"; readonly SET_THEME_OVERRIDE: "SET_THEME_OVERRIDE"; readonly PRELOAD_THEMES: "PRELOAD_THEMES"; readonly CREATE_SHARED_VIEW: "CREATE_SHARED_VIEW"; readonly CALLBACK_OPERATION_INVOKED: "CALLBACK_OPERATION_INVOKED"; readonly CONTENT_LOADED: "CONTENT_LOADED"; readonly EXPERIENCE_INITIALIZED: "EXPERIENCE_INITIALIZED"; readonly ERROR_OCCURRED: "ERROR_OCCURRED"; readonly SIZE_CHANGED: "SIZE_CHANGED"; readonly PARAMETERS_CHANGED: "PARAMETERS_CHANGED"; readonly SELECTED_SHEET_CHANGED: "SELECTED_SHEET_CHANGED"; readonly MODAL_OPENED: "MODAL_OPENED"; readonly Q_SEARCH_CLOSED: "Q_SEARCH_CLOSED"; readonly Q_SEARCH_OPENED: "Q_SEARCH_OPENED"; readonly Q_SEARCH_FOCUSED: "Q_SEARCH_FOCUSED"; readonly Q_SEARCH_SIZE_CHANGED: "Q_SEARCH_SIZE_CHANGED"; readonly Q_SEARCH_ENTERED_FULLSCREEN: "Q_SEARCH_ENTERED_FULLSCREEN"; readonly Q_SEARCH_EXITED_FULLSCREEN: "Q_SEARCH_EXITED_FULLSCREEN"; readonly Q_PANEL_ENTERED_FULLSCREEN: "Q_PANEL_ENTERED_FULLSCREEN"; readonly Q_PANEL_EXITED_FULLSCREEN: "Q_PANEL_EXITED_FULLSCREEN"; readonly PAGE_NAVIGATION: "PAGE_NAVIGATION"; readonly PARAMETERS_LOADED: "PARAMETERS_LOADED"; }; export declare type MessageEventName = (typeof MessageEventName)[keyof typeof MessageEventName]; export declare interface MetricColumn { Integer?: { Column: ColumnIdentifier; AggregationFunction?: AggregationFunction['NumericalAggregationFunction']; }; Decimal?: { Column: ColumnIdentifier; AggregationFunction?: AggregationFunction['NumericalAggregationFunction']; }; String?: { Column: ColumnIdentifier; AggregationFunction?: AggregationFunction['CategoricalAggregationFunction']; }; DateTime?: { Column: ColumnIdentifier; AggregationFunction?: AggregationFunction['DateAggregationFunction']; }; Calculated?: { Column: ColumnIdentifier; Expression: string; Type: keyof typeof CALCULATED_METRIC_COLUMN_TYPE; }; Bin?: { Column: ColumnIdentifier; }; } export declare type NavigateToDashboardOptions = { parameters?: Parameter[]; }; export declare interface Parameter { Name: string; Values: ParameterValue[]; } export declare type ParametersAsObject = Record; export declare type ParameterValue = string | number; export declare class PostMessageEvent extends TargetedMessageEvent { timestamp: number; version: string; eventId: string; constructor(eventName: EventName, eventTarget: InternalExperiences, eventId: string, timestamp: number, version: string, message?: EventMessageValue, data?: EventData); } export declare type PostRequest = { remove: () => void; }; export declare type Primitives = string | number | boolean; export declare interface PromptOptions { /** * Whether the attach files button will be shown and files can be uploaded * via drag and drop onto the prompt. */ allowFileAttachments?: boolean; /** * A prompt that will be sent once on initial chat panel load. */ initialPrompt?: string; /** * Whether the agent knowledge boundary menu will be shown. */ showAgentKnowledgeBoundary?: boolean; /** * Whether to show a user message from the configured initial prompt. */ showInitialPromptMessage?: boolean; /** * Whether the web search button will be shown. */ showWebSearch?: boolean; /** * Whether to show or hide the prompt box and disclaimer. */ showPromptArea?: boolean; /** * Whether to show or hide the header with the action buttons and history.. */ showChatHistory?: boolean; /** * Whether to toggle private mode for the embedded chat. */ enablePrivateMode?: boolean; } /** * Namespaces enums under one import for convenience * * @deprecated - Enums can be imported directly */ export declare const QSE: { GenerativeQnAPanelType: { readonly FULL: "FULL"; readonly SEARCH_BAR: "SEARCH_BAR"; }; SPECIAL_DATAPOINT_VALUE_TYPES: { readonly NULL: null; readonly OTHER_BUCKET: null; }; CALCULATED_METRIC_COLUMN_TYPE: { readonly INTEGER: null; readonly STRING: null; readonly DECIMAL: null; readonly DATETIME: null; }; ExperienceType: { readonly CONSOLE: "CONSOLE"; readonly CONTEXT: "CONTEXT"; readonly CONTROL: "CONTROL"; readonly VISUAL: "VISUAL"; readonly DASHBOARD: "DASHBOARD"; readonly QSEARCH: "QSEARCH"; readonly GENERATIVEQNA: "QSEARCH"; readonly QUICKCHAT: "QUICKCHAT"; }; ChangeEventName: { readonly UNRECOGNIZED_CONTENT_OPTIONS: "UNRECOGNIZED_CONTENT_OPTIONS"; readonly UNRECOGNIZED_FRAME_OPTIONS: "UNRECOGNIZED_FRAME_OPTIONS"; readonly UNRECOGNIZED_EVENT_TARGET: "UNRECOGNIZED_EVENT_TARGET"; readonly FRAME_NOT_CREATED: "FRAME_NOT_CREATED"; readonly NO_BODY: "NO_BODY"; readonly NO_CONTAINER: "NO_CONTAINER"; readonly INVALID_CONTAINER: "INVALID_CONTAINER"; readonly NO_URL: "NO_URL"; readonly INVALID_URL: "INVALID_URL"; readonly NO_FRAME_OPTIONS: "NO_FRAME_OPTIONS"; readonly INVALID_FRAME_OPTIONS: "INVALID_FRAME_OPTIONS"; readonly FRAME_STARTED: "FRAME_STARTED"; readonly FRAME_MOUNTED: "FRAME_MOUNTED"; readonly FRAME_LOADED: "FRAME_LOADED"; readonly FRAME_REMOVED: "FRAME_REMOVED"; }; MessageEventName: { readonly ACKNOWLEDGE: "ACKNOWLEDGE"; readonly INITIATE_PRINT: "INITIATE_PRINT"; readonly NAVIGATE_TO_DASHBOARD: "NAVIGATE_TO_DASHBOARD"; readonly CLOSE_Q_SEARCH: "CLOSE_Q_SEARCH"; readonly UNDO: "UNDO"; readonly REDO: "REDO"; readonly RESET: "RESET"; readonly TOGGLE_EXECUTIVE_SUMMARY_PANE: "TOGGLE_EXECUTIVE_SUMMARY_PANE"; readonly OPEN_BUILD_VISUAL_PANE: "OPEN_BUILD_VISUAL_PANE"; readonly OPEN_DATA_QNA_PANE: "OPEN_DATA_QNA_PANE"; readonly TOGGLE_BOOKMARKS_PANE: "TOGGLE_BOOKMARKS_PANE"; readonly TOGGLE_THRESHOLD_ALERTS_PANE: "TOGGLE_THRESHOLD_ALERTS_PANE"; readonly TOGGLE_SCHEDULING_PANE: "TOGGLE_SCHEDULING_PANE"; readonly TOGGLE_RECENT_SNAPSHOTS_PANE: "TOGGLE_RECENT_SNAPSHOTS_PANE"; readonly IMPORT_OBJECTS: "IMPORT_OBJECTS"; readonly OPEN_BUILD_STORY_PANE: "OPEN_BUILD_STORY_PANE"; readonly SEND_PROMPT: "SEND_PROMPT"; readonly GET_PARAMETERS: "GET_PARAMETERS"; readonly GET_SHEETS: "GET_SHEETS"; readonly GET_SHEET_VISUALS: "GET_SHEET_VISUALS"; readonly GET_VISUAL_ACTIONS: "GET_VISUAL_ACTIONS"; readonly GET_SELECTED_SHEET_ID: "GET_SELECTED_SHEET_ID"; readonly GET_FILTER_GROUPS_FOR_SHEET: "GET_FILTER_GROUPS_FOR_SHEET"; readonly GET_FILTER_GROUPS_FOR_VISUAL: "GET_FILTER_GROUPS_FOR_VISUAL"; readonly SET_PARAMETERS: "SET_PARAMETERS"; readonly SET_SELECTED_SHEET_ID: "SET_SELECTED_SHEET_ID"; readonly SET_Q_SEARCH_QUESTION: "SET_Q_SEARCH_QUESTION"; readonly SET_VISUAL_ACTIONS: "SET_VISUAL_ACTIONS"; readonly SET_THEME: "SET_THEME"; readonly ADD_FILTER_GROUPS: "ADD_FILTER_GROUPS"; readonly UPDATE_FILTER_GROUPS: "UPDATE_FILTER_GROUPS"; readonly REMOVE_FILTER_GROUPS: "REMOVE_FILTER_GROUPS"; readonly ADD_VISUAL_ACTIONS: "ADD_VISUAL_ACTIONS"; readonly REMOVE_VISUAL_ACTIONS: "REMOVE_VISUAL_ACTIONS"; readonly SET_THEME_OVERRIDE: "SET_THEME_OVERRIDE"; readonly PRELOAD_THEMES: "PRELOAD_THEMES"; readonly CREATE_SHARED_VIEW: "CREATE_SHARED_VIEW"; readonly CALLBACK_OPERATION_INVOKED: "CALLBACK_OPERATION_INVOKED"; readonly CONTENT_LOADED: "CONTENT_LOADED"; readonly EXPERIENCE_INITIALIZED: "EXPERIENCE_INITIALIZED"; readonly ERROR_OCCURRED: "ERROR_OCCURRED"; readonly SIZE_CHANGED: "SIZE_CHANGED"; readonly PARAMETERS_CHANGED: "PARAMETERS_CHANGED"; readonly SELECTED_SHEET_CHANGED: "SELECTED_SHEET_CHANGED"; readonly MODAL_OPENED: "MODAL_OPENED"; readonly Q_SEARCH_CLOSED: "Q_SEARCH_CLOSED"; readonly Q_SEARCH_OPENED: "Q_SEARCH_OPENED"; readonly Q_SEARCH_FOCUSED: "Q_SEARCH_FOCUSED"; readonly Q_SEARCH_SIZE_CHANGED: "Q_SEARCH_SIZE_CHANGED"; readonly Q_SEARCH_ENTERED_FULLSCREEN: "Q_SEARCH_ENTERED_FULLSCREEN"; readonly Q_SEARCH_EXITED_FULLSCREEN: "Q_SEARCH_EXITED_FULLSCREEN"; readonly Q_PANEL_ENTERED_FULLSCREEN: "Q_PANEL_ENTERED_FULLSCREEN"; readonly Q_PANEL_EXITED_FULLSCREEN: "Q_PANEL_EXITED_FULLSCREEN"; readonly PAGE_NAVIGATION: "PAGE_NAVIGATION"; readonly PARAMETERS_LOADED: "PARAMETERS_LOADED"; }; ChangeEventLevel: { readonly ERROR: "ERROR"; readonly INFO: "INFO"; readonly WARN: "WARN"; }; InfoMessageEventName: { readonly CALLBACK_OPERATION_INVOKED: "CALLBACK_OPERATION_INVOKED"; readonly CONTENT_LOADED: "CONTENT_LOADED"; readonly EXPERIENCE_INITIALIZED: "EXPERIENCE_INITIALIZED"; readonly ERROR_OCCURRED: "ERROR_OCCURRED"; readonly SIZE_CHANGED: "SIZE_CHANGED"; readonly PARAMETERS_CHANGED: "PARAMETERS_CHANGED"; readonly SELECTED_SHEET_CHANGED: "SELECTED_SHEET_CHANGED"; readonly MODAL_OPENED: "MODAL_OPENED"; readonly Q_SEARCH_CLOSED: "Q_SEARCH_CLOSED"; readonly Q_SEARCH_OPENED: "Q_SEARCH_OPENED"; readonly Q_SEARCH_FOCUSED: "Q_SEARCH_FOCUSED"; readonly Q_SEARCH_SIZE_CHANGED: "Q_SEARCH_SIZE_CHANGED"; readonly Q_SEARCH_ENTERED_FULLSCREEN: "Q_SEARCH_ENTERED_FULLSCREEN"; readonly Q_SEARCH_EXITED_FULLSCREEN: "Q_SEARCH_EXITED_FULLSCREEN"; readonly Q_PANEL_ENTERED_FULLSCREEN: "Q_PANEL_ENTERED_FULLSCREEN"; readonly Q_PANEL_EXITED_FULLSCREEN: "Q_PANEL_EXITED_FULLSCREEN"; readonly PAGE_NAVIGATION: "PAGE_NAVIGATION"; readonly PARAMETERS_LOADED: "PARAMETERS_LOADED"; }; InfoChangeEventName: { readonly FRAME_STARTED: "FRAME_STARTED"; readonly FRAME_MOUNTED: "FRAME_MOUNTED"; readonly FRAME_LOADED: "FRAME_LOADED"; readonly FRAME_REMOVED: "FRAME_REMOVED"; }; ErrorChangeEventName: { readonly FRAME_NOT_CREATED: "FRAME_NOT_CREATED"; readonly NO_BODY: "NO_BODY"; readonly NO_CONTAINER: "NO_CONTAINER"; readonly INVALID_CONTAINER: "INVALID_CONTAINER"; readonly NO_URL: "NO_URL"; readonly INVALID_URL: "INVALID_URL"; readonly NO_FRAME_OPTIONS: "NO_FRAME_OPTIONS"; readonly INVALID_FRAME_OPTIONS: "INVALID_FRAME_OPTIONS"; }; WarnChangeEventName: { readonly UNRECOGNIZED_CONTENT_OPTIONS: "UNRECOGNIZED_CONTENT_OPTIONS"; readonly UNRECOGNIZED_FRAME_OPTIONS: "UNRECOGNIZED_FRAME_OPTIONS"; readonly UNRECOGNIZED_EVENT_TARGET: "UNRECOGNIZED_EVENT_TARGET"; }; SetterMessageEventName: { readonly SET_PARAMETERS: "SET_PARAMETERS"; readonly SET_SELECTED_SHEET_ID: "SET_SELECTED_SHEET_ID"; readonly SET_Q_SEARCH_QUESTION: "SET_Q_SEARCH_QUESTION"; readonly SET_VISUAL_ACTIONS: "SET_VISUAL_ACTIONS"; readonly SET_THEME: "SET_THEME"; readonly ADD_FILTER_GROUPS: "ADD_FILTER_GROUPS"; readonly UPDATE_FILTER_GROUPS: "UPDATE_FILTER_GROUPS"; readonly REMOVE_FILTER_GROUPS: "REMOVE_FILTER_GROUPS"; readonly ADD_VISUAL_ACTIONS: "ADD_VISUAL_ACTIONS"; readonly REMOVE_VISUAL_ACTIONS: "REMOVE_VISUAL_ACTIONS"; readonly SET_THEME_OVERRIDE: "SET_THEME_OVERRIDE"; readonly PRELOAD_THEMES: "PRELOAD_THEMES"; readonly CREATE_SHARED_VIEW: "CREATE_SHARED_VIEW"; }; GetterMessageEventName: { readonly GET_PARAMETERS: "GET_PARAMETERS"; readonly GET_SHEETS: "GET_SHEETS"; readonly GET_SHEET_VISUALS: "GET_SHEET_VISUALS"; readonly GET_VISUAL_ACTIONS: "GET_VISUAL_ACTIONS"; readonly GET_SELECTED_SHEET_ID: "GET_SELECTED_SHEET_ID"; readonly GET_FILTER_GROUPS_FOR_SHEET: "GET_FILTER_GROUPS_FOR_SHEET"; readonly GET_FILTER_GROUPS_FOR_VISUAL: "GET_FILTER_GROUPS_FOR_VISUAL"; }; InvokerMessageEventName: { readonly ACKNOWLEDGE: "ACKNOWLEDGE"; readonly INITIATE_PRINT: "INITIATE_PRINT"; readonly NAVIGATE_TO_DASHBOARD: "NAVIGATE_TO_DASHBOARD"; readonly CLOSE_Q_SEARCH: "CLOSE_Q_SEARCH"; readonly UNDO: "UNDO"; readonly REDO: "REDO"; readonly RESET: "RESET"; readonly TOGGLE_EXECUTIVE_SUMMARY_PANE: "TOGGLE_EXECUTIVE_SUMMARY_PANE"; readonly OPEN_BUILD_VISUAL_PANE: "OPEN_BUILD_VISUAL_PANE"; readonly OPEN_DATA_QNA_PANE: "OPEN_DATA_QNA_PANE"; readonly TOGGLE_BOOKMARKS_PANE: "TOGGLE_BOOKMARKS_PANE"; readonly TOGGLE_THRESHOLD_ALERTS_PANE: "TOGGLE_THRESHOLD_ALERTS_PANE"; readonly TOGGLE_SCHEDULING_PANE: "TOGGLE_SCHEDULING_PANE"; readonly TOGGLE_RECENT_SNAPSHOTS_PANE: "TOGGLE_RECENT_SNAPSHOTS_PANE"; readonly IMPORT_OBJECTS: "IMPORT_OBJECTS"; readonly OPEN_BUILD_STORY_PANE: "OPEN_BUILD_STORY_PANE"; readonly SEND_PROMPT: "SEND_PROMPT"; }; }; export declare interface QSearchContentOptions extends BaseContentOptions { hideIcon?: boolean; hideTopicName?: boolean; theme?: string; allowTopicSelection?: boolean; } export declare class QSearchExperience extends InternalQBaseExperience { protected experience: IQSearchExperience; protected internalExperience: InternalQSearchExperience; protected experienceFrame: QSearchExperienceFrame; protected experienceId: string; protected frameStyles?: FrameStyles; constructor(frameOptions: FrameOptions, contentOptions: QSearchContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set); protected extractExperienceFromUrl: (url: string) => IQSearchExperience; private interceptMessage; private transformQSearchContentOptions; } export declare class QSearchExperienceFrame extends BaseExperienceFrame { constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: QSearchContentOptions, transformedContentOptions: TransformedQSearchContentOptions, internalExperience: InternalQSearchExperience, experienceIdentifier: string, interceptMessage?: EventListener_2); buildExperienceUrl: (baseUrl: string) => string; } export declare type QThemeOptions = { themeArn?: string; }; export declare interface QuickChatContentOptions extends BaseContentOptions { /** * @deprecated use {@link AgentOptions.fixedAgentId} instead **/ fixedAgentArn?: string; agentOptions?: AgentOptions; promptOptions?: PromptOptions; footerOptions?: FooterOptions; } export declare class QuickChatExperience extends BaseExperience { protected readonly experience: IQuickChatExperience; protected readonly internalExperience: InternalQuickChatExperience; protected readonly experienceFrame: QuickChatExperienceFrame; protected readonly experienceId: string; constructor(frameOpts: FrameOptions, contentOptions: QuickChatContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set); protected extractExperienceFromUrl: (url: string) => IQuickChatExperience; sendPrompt: (prompt: string) => Promise; private transformQuickChatContentOptions; private validateFixedAgentId; } export declare class QuickChatExperienceFrame extends BaseExperienceFrame { constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: QuickChatContentOptions, transformedContentOptions: TransformedQuickChatContentOptions, internalExperience: InternalQuickChatExperience, experienceIdentifier: string, interceptMessage?: EventListener_2); buildExperienceUrl: (baseUrl: string) => string; } export declare abstract class ResponseMessage { abstract success: boolean; message?: EventMessageValue; } export declare const SDK_VERSION = "2.11.3"; export declare const SetterMessageEventName: { readonly SET_PARAMETERS: "SET_PARAMETERS"; readonly SET_SELECTED_SHEET_ID: "SET_SELECTED_SHEET_ID"; readonly SET_Q_SEARCH_QUESTION: "SET_Q_SEARCH_QUESTION"; readonly SET_VISUAL_ACTIONS: "SET_VISUAL_ACTIONS"; readonly SET_THEME: "SET_THEME"; readonly ADD_FILTER_GROUPS: "ADD_FILTER_GROUPS"; readonly UPDATE_FILTER_GROUPS: "UPDATE_FILTER_GROUPS"; readonly REMOVE_FILTER_GROUPS: "REMOVE_FILTER_GROUPS"; readonly ADD_VISUAL_ACTIONS: "ADD_VISUAL_ACTIONS"; readonly REMOVE_VISUAL_ACTIONS: "REMOVE_VISUAL_ACTIONS"; readonly SET_THEME_OVERRIDE: "SET_THEME_OVERRIDE"; readonly PRELOAD_THEMES: "PRELOAD_THEMES"; readonly CREATE_SHARED_VIEW: "CREATE_SHARED_VIEW"; }; export declare type SetterMessageEventName = (typeof SetterMessageEventName)[keyof typeof SetterMessageEventName]; export declare type SetterMessageEvents = EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent | EmbeddingMessageEvent; export declare interface Sheet { Name: string; SheetId: string; } export declare interface SheetOptions { initialSheetId?: string; singleSheet?: boolean; emitSizeChangedEventOnSheetChange?: boolean; fitSheetToWidth?: boolean; } export declare const SPECIAL_DATAPOINT_VALUE_TYPES: { readonly NULL: null; readonly OTHER_BUCKET: null; }; export declare class SuccessResponse implements ResponseMessage { success: boolean; } export declare class TargetedMessageEvent extends EmbeddingMessageEvent { eventTarget: InternalExperiences; constructor(eventName: EventName, eventTarget: InternalExperiences, message?: EventMessageValue, data?: EventData); } export declare type ThemeOptions = { themeArn?: string; themeOverride?: ThemeConfiguration; preloadThemes?: string[]; }; export declare interface ToolbarOption { show?: true; } export declare interface ToolbarOptions { export?: boolean | ExportToolbarOption; undoRedo?: boolean | ToolbarOption; reset?: boolean | ToolbarOption; bookmarks?: boolean | ToolbarOption; thresholdAlerts?: boolean | ToolbarOption; scheduling?: boolean | ToolbarOption; recentSnapshots?: boolean | ToolbarOption; executiveSummary?: boolean | ToolbarOption; } export declare interface TransformedConsoleContentOptions extends BaseContentOptions { locale?: string; showExecutiveSummaryIcon?: boolean; showDataQnAIcon?: boolean; showBuildVisualIcon?: boolean; showBuildStoryIcon?: boolean; } export declare type TransformedContentOptions = TransformedConsoleContentOptions | TransformedDashboardContentOptions | TransformedQSearchContentOptions | TransformedVisualContentOptions | TransformedGenerativeQnAContentOptions | TransformedQuickChatContentOptions | object; export declare interface TransformedDashboardContentOptions extends BaseContentOptions { parameters?: ParametersAsObject; locale?: string; sheetId?: string | undefined; footerPaddingEnabled?: boolean; undoRedoDisabled?: boolean; printEnabled?: boolean; showBookmarksIcon?: boolean; showThresholdAlertsIcon?: boolean; showSchedulingIcon?: boolean; showRecentSnapshotsIcon?: boolean; showExecutiveSummaryIcon?: boolean; hideAutoRefresh?: boolean; resetDisabled?: boolean; sheetTabsDisabled?: boolean; resizeOnSheetChange?: boolean; themeArn?: string; themeOverride?: ThemeConfiguration; fitSheetToWidth?: boolean; } export declare interface TransformedGenerativeQnAContentOptions extends BaseContentOptions { qShowTopicName?: boolean; qShowPinboard?: boolean; qShowSearchBar?: boolean; qShowInterpretedAs?: boolean; qShowFeedback?: boolean; qShowGeneratedNarrative?: boolean; qShowDidYouMean?: boolean; qShowComplementaryVisuals?: boolean; qShowQBusinessInsights?: boolean; qShowSeeWhy?: boolean; qAllowTopicSelection?: boolean; qAllowFullscreen?: boolean; qAllowReturn?: boolean; qSearchPlaceholderText?: string; qPanelType?: string; qPanelTitle?: string; qShowPanelIcon?: boolean; qPanelFocusedHeight?: string; qPanelExpandedHeight?: string; themeArn?: string; questionId?: string; answerId?: string; } export declare interface TransformedQSearchContentOptions extends BaseContentOptions { qBarIconDisabled?: boolean; qBarTopicNameDisabled?: boolean; themeId?: string; allowTopicSelection?: boolean; } export declare interface TransformedQuickChatContentOptions extends BaseContentOptions { allowFileAttachments?: boolean; fixedAgentId?: string; initialPrompt?: string; showAgentKnowledgeBoundary?: boolean; showBrandAttribution?: boolean; showInitialPromptMessage?: boolean; showUsagePolicy?: boolean; showWebSearch?: boolean; showPromptArea?: boolean; showChatHistory?: boolean; enablePrivateMode?: boolean; } export declare interface TransformedVisualContentOptions extends BaseContentOptions { locale?: string; scaleToContainer?: boolean; fitToIframeWidth?: boolean; parameters?: ParametersAsObject; themeArn?: string; themeOverride?: ThemeConfiguration; } export declare type UrlInfo = { sessionId: string; host: string; urlSearchParams?: URLSearchParams; }; export declare interface Visual { Name: string; VisualId: string; } export declare interface VisualAction extends VisualCustomAction { ActionOperations: ActionOperation[]; } export declare interface VisualContentOptions extends BaseContentOptions { locale?: string; parameters?: Parameter[]; scaleToContainer?: boolean; fitToIframeWidth?: boolean; themeOptions?: ThemeOptions; } export declare class VisualExperience extends BaseExperience { protected experience: IVisualExperience; protected internalExperience: InternalVisualExperience; protected experienceFrame: VisualExperienceFrame; protected experienceId: string; constructor(frameOptions: FrameOptions, contentOptions: VisualContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set); setParameters: (parameters: Parameter[]) => Promise; reset: () => Promise; addFilterGroups: (filterGroups: FilterGroup[]) => Promise; updateFilterGroups: (filterGroups: FilterGroup[]) => Promise; removeFilterGroups: (filterGroups: FilterGroup[] | string[]) => Promise; getFilterGroups: () => Promise; getActions: () => Promise; addActions: (actions: VisualAction[]) => Promise; setActions: (actions: VisualAction[]) => Promise; removeActions: (actions: VisualAction[]) => Promise; setTheme: (themeArn: string) => Promise; setThemeOverride: (themeOverride: ThemeConfiguration) => Promise; setPreloadThemes: (preloadThemes: string[]) => Promise; protected extractExperienceFromUrl: (url: string) => IVisualExperience; private interceptMessage; private transformVisualContentOptions; } export declare class VisualExperienceFrame extends BaseExperienceFrame { constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: VisualContentOptions, transformedContentOptions: TransformedVisualContentOptions, internalExperience: InternalVisualExperience, experienceIdentifier: string, interceptMessage?: EventListener_2); buildExperienceUrl: (baseUrl: string) => string; } export declare const WarnChangeEventName: { readonly UNRECOGNIZED_CONTENT_OPTIONS: "UNRECOGNIZED_CONTENT_OPTIONS"; readonly UNRECOGNIZED_FRAME_OPTIONS: "UNRECOGNIZED_FRAME_OPTIONS"; readonly UNRECOGNIZED_EVENT_TARGET: "UNRECOGNIZED_EVENT_TARGET"; }; export declare type WarnChangeEventName = (typeof WarnChangeEventName)[keyof typeof WarnChangeEventName]; export { }