@atlaskit/editor-common 69.2.1 → 69.3.0

package/dist/types/analytics/types/enums.d.ts

@@ -0,0 +1,313 @@
+export declare enum EVENT_TYPE {
+    OPERATIONAL = "operational",
+    SCREEN = "screen",
+    TRACK = "track",
+    UI = "ui"
+}
+export declare enum ACTION {
+    ACTIVATED = "activated",
+    ADDED = "added",
+    BROWSER_FREEZE = "browserFreeze",
+    CHANGED_BACKGROUND_COLOR = "changedBackgroundColor",
+    CHANGED_ICON = "changedIcon",
+    CHANGED_FULL_WIDTH_MODE = "changedFullWidthMode",
+    CHANGED_LAYOUT = "changedLayout",
+    CHANGED_REPLACEMENT_TEXT = "changedReplacementText",
+    CHANGED_TYPE = "changedType",
+    CHANGED_URL = "changedUrl",
+    CLEARED = "cleared",
+    CLICKED = "clicked",
+    CLOSED = "closed",
+    COMMITTED = "committed",
+    CONVERTED = "converted",
+    COPIED = "copied",
+    CUT = "cut",
+    DEACTIVATED = "deactivated",
+    DECREMENTED = "decremented",
+    DELETED = "deleted",
+    DISCARDED_INVALID_STEPS_FROM_TRANSACTION = "discardedInvalidStepsFromTransaction",
+    DISMISSED = "dismissed",
+    DISPATCHED_INVALID_TRANSACTION = "dispatchedInvalidTransaction",
+    DISPATCHED_VALID_TRANSACTION = "dispatchedValidTransaction",
+    EDITED = "edited",
+    EDITOR_CRASHED = "unhandledErrorCaught",
+    EDITOR_CRASHED_ADDITIONAL_INFORMATION = "unhandledErrorCaughtAdditionalInfo",
+    EDITOR_MOUNTED = "mounted",
+    EDITOR_TTI = "tti",
+    EDITOR_CONTENT_RETRIEVAL_PERFORMED = "contentRetrievalPerformed",
+    RE_RENDERED = "reRendered",
+    ENTERED = "entered",
+    ERRORED = "errored",
+    EXPOSED = "exposed",
+    FAILED_TO_UNMOUNT = "failedToUnmount",
+    FIND_NEXT_PERFORMED = "findNextPerformed",
+    FIND_PERFORMED = "findPerformed",
+    FIND_PREV_PERFORMED = "findPrevPerformed",
+    FORMATTED = "formatted",
+    HELP_OPENED = "helpOpened",
+    HIGHLIGHTED = "highlighted",
+    INCREMENTED = "incremented",
+    INDENTED = "indented",
+    INITIALISED = "initialised",
+    INPUT_PERF_SAMPLING = "inputPerfSampling",
+    INPUT_PERF_SAMPLING_AVG = "inputPerfSamplingAvg",
+    INSERTED = "inserted",
+    INVALID_DOCUMENT_ENCOUNTERED = "invalidDocumentEncountered",
+    INVOKED = "invoked",
+    LANGUAGE_SELECTED = "languageSelected",
+    LIST_ITEM_JOINED = "listItemJoined",
+    MATCHED = "matched",
+    MEDIA_LINK_TRANSFORMED = "mediaLinkTransformed",
+    NODE_CONTENT_SANITIZED = "nodeContentSanitized",
+    OPENED = "opened",
+    OUTDENTED = "outdented",
+    PASTED = "pasted",
+    PASTED_AS_PLAIN = "pastedAsPlain",
+    PASTED_TIMED = "pastedTimed",
+    PROSEMIRROR_RENDERED = "proseMirrorRendered",
+    REACT_NODEVIEW_RENDERED = "reactNodeViewRendered",
+    REPLACED_ALL = "replacedAll",
+    REPLACED_ONE = "replacedOne",
+    RESOLVED = "resolved",
+    SELECTED = "selected",
+    SHOWN = "shown",
+    SLOW_INPUT = "slowInput",
+    STARTED = "started",
+    STOPPED = "stopped",
+    SUBSTITUTED = "autoSubstituted",
+    SYNCHRONY_DISCONNECTED = "synchronyDisconnected",
+    SYNCHRONY_ENTITY_ERROR = "synchronyEntityError",
+    SYNCHRONY_ERROR = "synchronyError",
+    TEXT_LINK_MARK_TRANSFORMED = "textLinkMarkTransformed",
+    DEDUPE_MARKS_TRANSFORMED = "dedupeMarksTransformed",
+    NODES_MISSING_CONTENT_TRANSFORMED = "nodesMissingContentTransformed",
+    INDENTATION_MARKS_TRANSFORMED = "indentationMarksTransformed",
+    TOGGLE_EXPAND = "toggleExpand",
+    TRANSACTION_DISPATCHED = "transactionDispatched",
+    TRANSACTION_MUTATED_AFTER_DISPATCH = "transactionMutatedAfterDispatched",
+    TYPING_FINISHED = "typingFinished",
+    TYPING_STARTED = "typingStarted",
+    UNLINK = "unlinked",
+    UNSUPPORTED_CONTENT_ENCOUNTERED = "unsupportedContentEncountered",
+    UPDATED = "updated",
+    UPLOAD_EXTERNAL_FAIL = "uploadExternalFailed",
+    VIEWED = "viewed",
+    VISITED = "visited",
+    WITH_PLUGIN_STATE_CALLED = "withPluginStateCalled",
+    RENDERED = "rendered",
+    ON_EDITOR_READY_CALLBACK = "onEditorReadyCallback",
+    ON_CHANGE_CALLBACK = "onChangeCalled",
+    NEW_COLLAB_SYNC_UP_ERROR_NO_STEPS = "newCollabSyncUpErrorNoSteps",
+    REMOVE_ICON = "removedIcon",
+    UFO_SESSION_COMPLETE = "ufoSessionComplete",
+    INVALID_PROSEMIRROR_DOCUMENT = "invalidProsemirrorDocument",
+    DOCUMENT_PROCESSING_ERROR = "documentProcessingError"
+}
+export declare enum INPUT_METHOD {
+    ASCII = "ascii",
+    AUTO = "auto",
+    AUTO_DETECT = "autoDetect",
+    BUTTON = "button",
+    BLUR = "blur",
+    CARD = "card",
+    CLIPBOARD = "clipboard",
+    CONFIG_PANEL = "configPanel",
+    CONTEXT_MENU = "contextMenu",
+    DRAG_AND_DROP = "dragAndDrop",
+    EXTERNAL = "external",
+    EXTENSION_API = "extensionApi",
+    FLOATING_TB = "floatingToolbar",
+    FORMATTING = "autoformatting",
+    INSERT_MENU = "insertMenu",
+    KEYBOARD = "keyboard",
+    MACRO_BROWSER = "macroBrowser",
+    MANUAL = "manual",
+    PICKER = "picker",
+    PICKER_CLOUD = "cloudPicker",
+    PREFILL = "prefill",
+    QUICK_INSERT = "quickInsert",
+    SHORTCUT = "shortcut",
+    TOOLBAR = "toolbar",
+    TYPEAHEAD = "typeAhead"
+}
+export declare enum TRIGGER_METHOD {
+    BUTTON = "button",
+    KEYBOARD = "keyboard",
+    SHORTCUT = "shortcut",
+    TOOLBAR = "toolbar"
+}
+export declare enum ACTION_SUBJECT {
+    TOOLBAR_BUTTON = "toolbarButton",
+    BUTTON = "button",
+    CONFIG_PANEL = "configPanel",
+    CONTENT_COMPONENT = "contentComponent",
+    DATE = "date",
+    DATE_SEGMENT = "dateSegment",
+    DOCUMENT = "document",
+    EDITOR = "editor",
+    ELEMENT_BROWSER = "elementBrowser",
+    EMBEDS = "embeds",
+    EXPAND = "expand",
+    EXTENSION = "extension",
+    FEATURE = "feature",
+    FEEDBACK_DIALOG = "feedbackDialog",
+    FIND_REPLACE_DIALOG = "findReplaceDialog",
+    FLOATING_CONTEXTUAL_BUTTON = "floatingContextualButton",
+    FLOATING_TOOLBAR_PLUGIN = "floatingToolbarPlugin",
+    HELP = "help",
+    LAYOUT = "layout",
+    LIST = "list",
+    MEDIA = "media",
+    MEDIA_SINGLE = "mediaSingle",
+    NESTED_EXPAND = "nestedExpand",
+    PANEL = "panel",
+    PICKER = "picker",
+    PLUS_MENU = "plusMenu",
+    PLUGIN_SLOT = "pluginSlot",
+    REACT_NODE_VIEW = "reactNodeView",
+    SELECTION = "selection",
+    SMART_LINK = "smartLink",
+    HYPERLINK = "hyperlink",
+    TABLE = "table",
+    TABLES_PLUGIN = "tablesPlugin",
+    TEXT = "text",
+    TOOLBAR = "toolbar",
+    TYPEAHEAD = "typeAhead",
+    TYPEAHEAD_ITEM = "typeAheadItem",
+    ANNOTATION = "annotation",
+    SEARCH_RESULT = "searchResult",
+    CREATE_LINK_INLINE_DIALOG = "createLinkInlineDialog",
+    CODE_BLOCK = "codeBlock",
+    REACT_EDITOR_VIEW = "reactEditorView"
+}
+export declare enum ACTION_SUBJECT_ID {
+    ACTION = "action",
+    ALL = "all",
+    ALT_TEXT = "altText",
+    ANNOTATE_BUTTON = "annotateButton",
+    AVATAR_GROUP_PLUGIN = "AvatarGroupInPlugin",
+    BLOCK_QUOTE = "blockQuote",
+    BUTTON_FEEDBACK = "feedbackButton",
+    BUTTON_HELP = "helpButton",
+    BUTTON_CATEGORY = "categoryButton",
+    CANCEL = "cancel",
+    CARD_BLOCK = "blockCard",
+    CAPTION = "caption",
+    CARD_INLINE = "inlineCard",
+    CELL = "cell",
+    CODE_BLOCK = "codeBlock",
+    DATE = "date",
+    DATE_DAY = "day",
+    DATE_MONTH = "month",
+    DATE_YEAR = "year",
+    DECISION = "decision",
+    DIVIDER = "divider",
+    EMOJI = "emoji",
+    EXPAND = "expand",
+    EXTENSION = "extension",
+    EXTENSION_API = "extensionApi",
+    EXTENSION_BLOCK = "extension",
+    EXTENSION_BODIED = "bodiedExtension",
+    EXTENSION_INLINE = "inlineExtension",
+    FORMAT_BLOCK_QUOTE = "blockQuote",
+    FORMAT_CLEAR = "clearFormatting",
+    FORMAT_CODE = "code",
+    FORMAT_COLOR = "color",
+    FORMAT_HEADING = "heading",
+    FORMAT_INDENT = "indentation",
+    FORMAT_ITALIC = "italic",
+    FORMAT_LIST_BULLET = "bulletedList",
+    FORMAT_LIST_NUMBER = "numberedList",
+    FORMAT_STRIKE = "strike",
+    FORMAT_STRONG = "strong",
+    FORMAT_SUB = "subscript",
+    FORMAT_SUPER = "superscript",
+    FORMAT_UNDERLINE = "underline",
+    HELP_QUICK_INSERT = "helpQuickInsert",
+    INLINE_COMMENT = "inlineComment",
+    LAYOUT = "layout",
+    RICH_MEDIA_LAYOUT = "richMediaLayout",
+    LINE_BREAK = "lineBreak",
+    LINK = "link",
+    LINK_PREVIEW = "linkPreview",
+    MEDIA = "media",
+    MEDIA_GROUP = "mediaGroup",
+    MEDIA_INLINE = "mediaInline",
+    MEDIA_SINGLE = "mediaSingle",
+    MEDIA_LINK = "mediaLink",
+    MENTION = "mention",
+    NESTED_EXPAND = "nestedExpand",
+    NODE = "node",
+    PANEL = "panel",
+    PASTE_BLOCK_CARD = "blockCard",
+    PASTE_BLOCKQUOTE = "blockQuote",
+    PASTE_BODIED_EXTENSION = "bodiedExtension",
+    PASTE_BULLET_LIST = "bulletList",
+    PASTE_CODE_BLOCK = "codeBlock",
+    PASTE_DECISION_LIST = "decisionList",
+    PASTE_EXPAND = "expand",
+    PASTE_EXTENSION = "extension",
+    PASTE_HEADING = "heading",
+    PASTE_MEDIA_GROUP = "mediaGroup",
+    PASTE_MEDIA_SINGLE = "mediaSingle",
+    PASTE_NESTED_EXPAND = "nestedExpand",
+    PASTE_ORDERED_LIST = "orderedList",
+    PASTE_PANEL = "panel",
+    PASTE_PARAGRAPH = "paragraph",
+    PASTE_RULE = "rule",
+    PASTE_TABLE = "table",
+    PASTE_TABLE_CELL = "tableCell",
+    PASTE_TABLE_HEADER = "tableHeader",
+    PASTE_TABLE_ROW = "tableRow",
+    PASTE_TASK_LIST = "taskList",
+    PICKER_COLOR = "colorPicker",
+    PICKER_CLOUD = "cloudPicker",
+    PICKER_EMOJI = "emojiPicker",
+    PRODUCT_NAME = "productName",
+    PLACEHOLDER_TEXT = "placeholderText",
+    PUNC = "punctuation",
+    RANGE = "range",
+    REACT_NODE_VIEW = "reactNodeView",
+    RESIZED = "resized",
+    SAVE = "save",
+    SECTION = "section",
+    SMART_LINK = "smartLink",
+    STATUS = "status",
+    SYMBOL = "symbol",
+    TABLE = "table",
+    TEXT = "text",
+    TYPEAHEAD_EMOJI = "emojiTypeAhead",
+    TYPEAHEAD_LINK = "linkTypeAhead",
+    TYPEAHEAD_MENTION = "mentionTypeAhead",
+    TYPEAHEAD_QUICK_INSERT = "quickInsertTypeAhead",
+    UNSUPPORTED_BLOCK = "unsupportedBlock",
+    UNSUPPORTED_INLINE = "unsupportedInline",
+    UNSUPPORTED_MARK = "unsupportedMark",
+    UNKNOWN_NODE = "unknownNode",
+    RECENT_ACTIVITIES = "recentActivities",
+    QUICK_SEARCH = "quickSearch",
+    LINK_SEARCH_INPUT = "linkSearchInput",
+    PRE_QUERY_SEARCH_RESULTS = "preQuerySearchResults",
+    POST_QUERY_SEARCH_RESULTS = "postQuerySearchResults",
+    EDIT_LINK = "editLink",
+    UNLINK = "unlink",
+    OPEN_LINK = "openLink",
+    EMBEDS = "embeds",
+    HYPERLINK = "hyperlink",
+    GOTO_SMART_LINK_SETTINGS = "goToSmartLinkSettings"
+}
+export declare enum FLOATING_CONTROLS_TITLE {
+    CODE_BLOCK = "codeBlockFloatingControls",
+    EXTENSION = "extensionFloatingControls",
+    HYPERLINK = "hyperlinkFloatingControls",
+    MEDIA = "mediaFloatingControls",
+    PANEL = "panelFloatingControls",
+    TABLE = "tableFloatingControls",
+    EXPAND = "expandToolbar"
+}
+export declare enum CONTENT_COMPONENT {
+    INLINE_COMMENT = "inlineComment",
+    FLOATING_CONTEXTUAL_BUTTON = "floatingContextualButton",
+    FLOATING_INSERT_BUTTON = "floatingInsertButton",
+    FLOATING_TOOLBAR = "floatingToolbar"
+}

package/dist/types/analytics/types/events.d.ts

@@ -0,0 +1,125 @@
+/// <reference types="react" />
+import type { EditorState, PluginKey } from 'prosemirror-state';
+import type { NewCollabSyncUpErrorAttributes } from '../../types';
+import type { UnsupportedContentPayload, UnsupportedContentTooltipPayload, UserBrowserExtensionResults } from '../../utils';
+import type { AvatarEventPayload } from './avatar';
+import type { ConfigPanelEventPayload } from './config-panel-events';
+import type { CutCopyEventPayload } from './cut-copy-events';
+import type { DateEventPayload } from './date-events';
+import type { ElementBrowserEventPayload } from './element-browser-events';
+import type { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, CONTENT_COMPONENT, FLOATING_CONTROLS_TITLE } from './enums';
+import type { ExperimentalEventPayload } from './experimental-events';
+import type { ExtensionEventPayload } from './extension-events';
+import type { FindReplaceEventPayload } from './find-replace-events';
+import type { FormatEventPayload } from './format-events';
+import type { GeneralEventPayload } from './general-events';
+import type { InsertEventPayload } from './insert-events';
+import type { CreateLinkInlineDialogEventPayload, EditLinkToolbarAEP, OpenSettingsToolbarAEP, UnlinkToolbarAEP } from './link-tool-bar-events';
+import type { ListEventPayload } from './list-events';
+import type { MediaEventPayload } from './media-events';
+import type { NodeEventPayload } from './node-events';
+import type { PasteEventPayload } from './paste-events';
+import type { SelectionEventPayload } from './selection-events';
+import type { SubstituteEventPayload } from './substitute-events';
+import type { TableEventPayload } from './table-events';
+import type { TypeAheadPayload } from './type-ahead';
+import type { OperationalAEP, OperationalExposureAEP, TrackAEP } from './utils';
+declare type Dispatch<T = any> = (eventName: PluginKey | string, data: T) => void;
+export declare type SimplifiedNode = {
+    type: string;
+    pos: number;
+    nodeSize: number;
+    marks?: string[];
+    content?: SimplifiedNode[];
+};
+export declare type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload;
+declare type CustomPanelEventPayload = TrackAEP<ACTION.CHANGED_BACKGROUND_COLOR | ACTION.CHANGED_ICON | ACTION.REMOVE_ICON, ACTION_SUBJECT.PANEL, ACTION_SUBJECT_ID.PANEL, {
+    previousColor: string;
+    newColor: string;
+} | {
+    previousIcon: string;
+    newIcon: string;
+} | {
+    icon: string;
+}, undefined>;
+export declare type AnalyticsEventPayloadWithChannel = {
+    channel: string;
+    payload: AnalyticsEventPayload;
+};
+export declare type AnalyticsDispatch = Dispatch<{
+    payload: AnalyticsEventPayload;
+    channel?: string;
+}>;
+export declare type FeatureExposureAEP = OperationalExposureAEP<ACTION.EXPOSED, ACTION_SUBJECT.FEATURE, undefined, {
+    flagKey: string;
+    value: string | boolean;
+}>;
+declare type InvalidTransactionErrorAEP = OperationalAEP<ACTION.DISPATCHED_INVALID_TRANSACTION, ACTION_SUBJECT.EDITOR, undefined, {
+    analyticsEventPayloads: AnalyticsEventPayloadWithChannel[];
+    invalidNodes: (SimplifiedNode | string)[];
+}, undefined>;
+declare type DispatchedValidTransactionAEP = OperationalAEP<ACTION.DISPATCHED_VALID_TRANSACTION, ACTION_SUBJECT.EDITOR, undefined, undefined, undefined>;
+declare type InvalidTransactionStepErrorAEP = OperationalAEP<ACTION.DISCARDED_INVALID_STEPS_FROM_TRANSACTION, ACTION_SUBJECT.EDITOR, undefined, {
+    analyticsEventPayloads: AnalyticsEventPayloadWithChannel[];
+}, undefined>;
+export declare type TransactionEventPayload = DispatchedValidTransactionAEP;
+declare type FailedToUnmountErrorAEP = OperationalAEP<ACTION.FAILED_TO_UNMOUNT, ACTION_SUBJECT.EDITOR, ACTION_SUBJECT_ID.REACT_NODE_VIEW, {
+    error: Error;
+    domNodes: {
+        container?: string;
+        child?: string;
+    };
+}, undefined>;
+declare type SynchronyErrorAEP = OperationalAEP<ACTION.SYNCHRONY_ERROR, ACTION_SUBJECT.EDITOR, undefined, {
+    error: Error;
+    docStructure?: string | SimplifiedNode;
+    browserExtensions?: UserBrowserExtensionResults;
+}, undefined>;
+declare type NewCollabSyncUpErrorAEP = OperationalAEP<ACTION.NEW_COLLAB_SYNC_UP_ERROR_NO_STEPS, ACTION_SUBJECT.EDITOR, undefined, NewCollabSyncUpErrorAttributes, undefined>;
+declare type InvalidDocumentEncounteredAEP = OperationalAEP<ACTION.INVALID_DOCUMENT_ENCOUNTERED, ACTION_SUBJECT.EDITOR, undefined, {
+    nodeType: string;
+    reason: string;
+    tableLocalId: string;
+    spanValue: number;
+}, undefined>;
+declare type SynchronyEntityErrorAEP = OperationalAEP<ACTION.SYNCHRONY_ENTITY_ERROR | ACTION.SYNCHRONY_DISCONNECTED, ACTION_SUBJECT.EDITOR, undefined, {
+    onLine: boolean;
+    visibilityState: string;
+}, undefined>;
+declare type ContentComponentErrorAEP = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.CONTENT_COMPONENT, undefined, {
+    component: CONTENT_COMPONENT;
+    error: string;
+    errorStack?: string;
+    selection: {
+        [key: string]: string;
+    };
+    position: number;
+    docSize: number;
+}, undefined>;
+export declare type ErrorEventAttributes = {
+    error: Error;
+    errorInfo: React.ErrorInfo;
+    product?: string;
+    browserInfo?: string;
+    errorId?: string;
+    docStructure?: string | SimplifiedNode;
+    browserExtensions?: UserBrowserExtensionResults;
+};
+declare type ComponentCrashErrorAEP = OperationalAEP<ACTION.EDITOR_CRASHED, ACTION_SUBJECT.FLOATING_CONTEXTUAL_BUTTON | ACTION_SUBJECT.PLUGIN_SLOT | ACTION_SUBJECT.REACT_NODE_VIEW | ACTION_SUBJECT.TABLES_PLUGIN | ACTION_SUBJECT.FLOATING_TOOLBAR_PLUGIN | ACTION_SUBJECT.EDITOR, ACTION_SUBJECT_ID | FLOATING_CONTROLS_TITLE, ErrorEventAttributes, undefined>;
+declare type ComponentCrashAdditionalInfoErrorAEP = OperationalAEP<ACTION.EDITOR_CRASHED_ADDITIONAL_INFORMATION, ACTION_SUBJECT.EDITOR, undefined, {
+    errorStack: string;
+    errorId: string;
+}, undefined>;
+declare type SmartLinkErrorAEP = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.SMART_LINK, undefined, {
+    error: string;
+    errorStack?: string;
+}, undefined>;
+export declare type ErrorEventPayload = InvalidTransactionErrorAEP | InvalidTransactionStepErrorAEP | FailedToUnmountErrorAEP | SynchronyErrorAEP | InvalidDocumentEncounteredAEP | SynchronyEntityErrorAEP | ContentComponentErrorAEP | ComponentCrashErrorAEP | ComponentCrashAdditionalInfoErrorAEP | SmartLinkErrorAEP;
+export declare type AnalyticsEventPayloadCallback = (state: EditorState) => AnalyticsEventPayload | undefined;
+export declare type FireAnalyticsCallback = <T>(payload: FireAnalyticsEventPayload<T>) => void | undefined;
+export declare type FireAnalyticsEvent = () => FireAnalyticsCallback;
+export declare type FireAnalyticsEventPayload<T = void> = {
+    payload: AnalyticsEventPayload<T>;
+    channel?: string;
+};
+export {};

package/dist/types/analytics/types/experimental-events.d.ts

@@ -0,0 +1,17 @@
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID } from './enums';
+import { TrackAEP } from './utils';
+declare type ExperimentalAEP<Action, ActionSubject, ActionSubjectId, Attributes> = TrackAEP<Action, ActionSubject, ActionSubjectId, Attributes & {
+    experiment: string;
+    experimentGroup: string;
+}, undefined>;
+export interface TextColorSelectedAttr {
+    color: string;
+    isNewColor: boolean;
+}
+export declare type TextColorSelectedAEP = ExperimentalAEP<ACTION.FORMATTED, ACTION_SUBJECT.TEXT, ACTION_SUBJECT_ID.FORMAT_COLOR, TextColorSelectedAttr>;
+export interface TextColorShowPaletteToggleAttr {
+    noSelect: boolean;
+}
+export declare type TextColorShowPaletteToggleAEP = ExperimentalAEP<ACTION.OPENED | ACTION.CLOSED, ACTION_SUBJECT.TOOLBAR, ACTION_SUBJECT_ID.FORMAT_COLOR, TextColorShowPaletteToggleAttr>;
+export declare type ExperimentalEventPayload = TextColorSelectedAEP | TextColorShowPaletteToggleAEP;
+export {};

package/dist/types/analytics/types/extension-events.d.ts

@@ -0,0 +1,37 @@
+import type { ExtensionLayout } from '@atlaskit/adf-schema';
+import type { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, INPUT_METHOD } from './enums';
+import type { SELECTION_TYPE, TrackAEP } from './utils';
+export declare enum GAP_CURSOR_POSITION {
+    LEFT = "left",
+    RIGHT = "right"
+}
+export declare enum TARGET_SELECTION_SOURCE {
+    CURRENT_SELECTION = "currentSelection",
+    HTML_ELEMENT = "htmlElement"
+}
+export declare type SelectionJson = {
+    type: SELECTION_TYPE;
+    anchor?: number;
+    head?: number;
+    side?: GAP_CURSOR_POSITION;
+    pos?: number;
+};
+export declare type ExtensionType = ACTION_SUBJECT_ID.EXTENSION_BLOCK | ACTION_SUBJECT_ID.EXTENSION_BODIED | ACTION_SUBJECT_ID.EXTENSION_INLINE;
+declare type ExtensionUpdateAEP = TrackAEP<ACTION.UPDATED | ACTION.ERRORED, ACTION_SUBJECT.EXTENSION, ExtensionType, {
+    extensionType: string;
+    /**
+     * extensionkey follows this format:
+     * `${manifest.key}:${manifest.modules.nodes.name}`
+     * e.g: 'awesome:item', 'awesome:default', 'awesome:list'
+     */
+    extensionKey: string;
+    layout?: ExtensionLayout;
+    localId?: string;
+    selection: SelectionJson;
+    targetSelectionSource: TARGET_SELECTION_SOURCE;
+}, INPUT_METHOD.MACRO_BROWSER | INPUT_METHOD.CONFIG_PANEL | INPUT_METHOD.TOOLBAR>;
+declare type ExtensionAPICalledPayload = TrackAEP<ACTION.INVOKED, ACTION_SUBJECT.EXTENSION, ACTION_SUBJECT_ID.EXTENSION_API, {
+    functionName: string;
+}, INPUT_METHOD.EXTENSION_API>;
+export declare type ExtensionEventPayload = ExtensionUpdateAEP | ExtensionAPICalledPayload;
+export {};

package/dist/types/analytics/types/find-replace-events.d.ts

@@ -0,0 +1,23 @@
+import type { ACTION, ACTION_SUBJECT, INPUT_METHOD, TRIGGER_METHOD } from './enums';
+import type { TrackAEP, UIAEP } from './utils';
+declare type ActivateAEP = UIAEP<ACTION.ACTIVATED, ACTION_SUBJECT.FIND_REPLACE_DIALOG, undefined, {
+    inputMethod: INPUT_METHOD.KEYBOARD | INPUT_METHOD.PREFILL;
+    triggerMethod: TRIGGER_METHOD.SHORTCUT | TRIGGER_METHOD.TOOLBAR;
+}, undefined>;
+declare type DeactivateAEP = UIAEP<ACTION.DEACTIVATED, ACTION_SUBJECT.FIND_REPLACE_DIALOG, undefined, {
+    triggerMethod: TRIGGER_METHOD.KEYBOARD | TRIGGER_METHOD.TOOLBAR | TRIGGER_METHOD.BUTTON;
+}, undefined>;
+declare type FindAEP = TrackAEP<ACTION.FIND_PERFORMED, ACTION_SUBJECT.TEXT, undefined, undefined, undefined>;
+declare type FindNextAEP = TrackAEP<ACTION.FIND_NEXT_PERFORMED, ACTION_SUBJECT.TEXT, undefined, {
+    triggerMethod: TRIGGER_METHOD.KEYBOARD | TRIGGER_METHOD.BUTTON;
+}, undefined>;
+declare type FindPrevAEP = TrackAEP<ACTION.FIND_PREV_PERFORMED, ACTION_SUBJECT.TEXT, undefined, {
+    triggerMethod: TRIGGER_METHOD.KEYBOARD | TRIGGER_METHOD.BUTTON;
+}, undefined>;
+declare type ReplaceTextChangeAEP = TrackAEP<ACTION.CHANGED_REPLACEMENT_TEXT, ACTION_SUBJECT.FIND_REPLACE_DIALOG, undefined, undefined, undefined>;
+declare type ReplaceOneAEP = TrackAEP<ACTION.REPLACED_ONE, ACTION_SUBJECT.TEXT, undefined, {
+    triggerMethod: TRIGGER_METHOD.KEYBOARD | TRIGGER_METHOD.BUTTON;
+}, undefined>;
+declare type ReplaceAllAEP = TrackAEP<ACTION.REPLACED_ALL, ACTION_SUBJECT.TEXT, undefined, undefined, undefined>;
+export declare type FindReplaceEventPayload = ActivateAEP | DeactivateAEP | FindAEP | FindNextAEP | FindPrevAEP | ReplaceTextChangeAEP | ReplaceOneAEP | ReplaceAllAEP;
+export {};

package/dist/types/analytics/types/format-events.d.ts

@@ -0,0 +1,49 @@
+import type { HeadingLevelsAndNormalText } from './block';
+import type { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, INPUT_METHOD } from './enums';
+import type { TrackAEP } from './utils';
+export declare enum INDENT_DIRECTION {
+    INDENT = "indent",
+    OUTDENT = "outdent"
+}
+export declare enum INDENT_TYPE {
+    PARAGRAPH = "paragraph",
+    LIST = "list",
+    HEADING = "heading",
+    CODE_BLOCK = "codeBlock",
+    TASK_LIST = "taskList"
+}
+declare type FormatAEP<ActionSubjectID, Attributes> = TrackAEP<ACTION.FORMATTED, ACTION_SUBJECT.TEXT, ActionSubjectID, Attributes, undefined>;
+declare type FormatBasicAEP = FormatAEP<ACTION_SUBJECT_ID.FORMAT_STRONG | ACTION_SUBJECT_ID.FORMAT_ITALIC | ACTION_SUBJECT_ID.FORMAT_UNDERLINE | ACTION_SUBJECT_ID.FORMAT_CODE | ACTION_SUBJECT_ID.FORMAT_STRIKE, {
+    inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT | INPUT_METHOD.FORMATTING | INPUT_METHOD.FLOATING_TB;
+}>;
+declare type FormatSuperSubAEP = FormatAEP<ACTION_SUBJECT_ID.FORMAT_SUPER | ACTION_SUBJECT_ID.FORMAT_SUB, {
+    inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT | INPUT_METHOD.FORMATTING;
+}>;
+declare type FormatIndentationAEP = FormatAEP<ACTION_SUBJECT_ID.FORMAT_INDENT, {
+    inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.KEYBOARD;
+    direction: INDENT_DIRECTION.INDENT | INDENT_DIRECTION.OUTDENT;
+    previousIndentationLevel: number;
+    newIndentLevel: number;
+    indentType: INDENT_TYPE.PARAGRAPH | INDENT_TYPE.LIST | INDENT_TYPE.HEADING | INDENT_TYPE.CODE_BLOCK | INDENT_TYPE.TASK_LIST;
+}>;
+declare type FormatHeadingAEP = FormatAEP<ACTION_SUBJECT_ID.FORMAT_HEADING, {
+    inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.FORMATTING | INPUT_METHOD.SHORTCUT | INPUT_METHOD.QUICK_INSERT;
+    newHeadingLevel: HeadingLevelsAndNormalText;
+    previousHeadingLevel?: HeadingLevelsAndNormalText;
+}>;
+declare type FormatBlockQuoteAEP = FormatAEP<ACTION_SUBJECT_ID.FORMAT_BLOCK_QUOTE, {
+    inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.FORMATTING | INPUT_METHOD.SHORTCUT | INPUT_METHOD.QUICK_INSERT;
+}>;
+declare type FormatClearAEP = FormatAEP<ACTION_SUBJECT_ID.FORMAT_CLEAR, {
+    inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT;
+    formattingCleared: string[];
+}>;
+declare type FormatColorAEP = FormatAEP<ACTION_SUBJECT_ID.FORMAT_COLOR, {
+    newColor: string;
+    previousColor: string;
+}>;
+declare type FormatListAEP = FormatAEP<ACTION_SUBJECT_ID.FORMAT_LIST_NUMBER | ACTION_SUBJECT_ID.FORMAT_LIST_BULLET, {
+    inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.KEYBOARD | INPUT_METHOD.FORMATTING | INPUT_METHOD.QUICK_INSERT;
+}>;
+export declare type FormatEventPayload = FormatBasicAEP | FormatSuperSubAEP | FormatIndentationAEP | FormatHeadingAEP | FormatBlockQuoteAEP | FormatClearAEP | FormatColorAEP | FormatListAEP;
+export {};