@atlaskit/editor-common 94.13.1 → 94.14.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-common
 
+## 94.14.0
+
+### Minor Changes
+
+- [#160752](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/160752)
+  [`d86736afc929e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/d86736afc929e) -
+  EDF-1887: Add UI analytics tracking for button and highlight clicks and tie Editor and Definition
+  Modal events with common readingAidsSessionId
+
 ## 94.13.1
 
 ### Patch Changes

package/dist/cjs/analytics/types/ai-definitions-events.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/analytics/types/enums.js

@@ -266,10 +266,13 @@ var ACTION_SUBJECT = exports.ACTION_SUBJECT = /*#__PURE__*/function (ACTION_SUBJ
   ACTION_SUBJECT["INLINE_DIALOG"] = "inlineDialog";
   ACTION_SUBJECT["ENGAGEMENT_PLATFORM"] = "engagementPlatform";
   ACTION_SUBJECT["MEDIA_VIEWER"] = "mediaViewer";
+  ACTION_SUBJECT["DECORATION"] = "decoration";
   return ACTION_SUBJECT;
 }({});
 var ACTION_SUBJECT_ID = exports.ACTION_SUBJECT_ID = /*#__PURE__*/function (ACTION_SUBJECT_ID) {
   ACTION_SUBJECT_ID["ACTION"] = "action";
+  ACTION_SUBJECT_ID["AI_DEFINITIONS_DEFINE_BUTTON"] = "aiDefinitionsDefineButton";
+  ACTION_SUBJECT_ID["AI_DEFINITIONS_AUTO_HIGHLIGHT"] = "aiDefinitionsAutoHighlight";
   ACTION_SUBJECT_ID["ALL"] = "all";
   ACTION_SUBJECT_ID["ALT_TEXT"] = "altText";
   ACTION_SUBJECT_ID["ANNOTATE_BUTTON"] = "annotateButton";

package/dist/cjs/monitoring/error.js

@@ -17,7 +17,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "94.13.1";
+var packageVersion = "94.14.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "94.13.1";
+var packageVersion = "94.14.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/es2019/analytics/types/ai-definitions-events.js

@@ -0,0 +1 @@
+export {};

package/dist/es2019/analytics/types/enums.js

@@ -260,10 +260,13 @@ export let ACTION_SUBJECT = /*#__PURE__*/function (ACTION_SUBJECT) {
   ACTION_SUBJECT["INLINE_DIALOG"] = "inlineDialog";
   ACTION_SUBJECT["ENGAGEMENT_PLATFORM"] = "engagementPlatform";
   ACTION_SUBJECT["MEDIA_VIEWER"] = "mediaViewer";
+  ACTION_SUBJECT["DECORATION"] = "decoration";
   return ACTION_SUBJECT;
 }({});
 export let ACTION_SUBJECT_ID = /*#__PURE__*/function (ACTION_SUBJECT_ID) {
   ACTION_SUBJECT_ID["ACTION"] = "action";
+  ACTION_SUBJECT_ID["AI_DEFINITIONS_DEFINE_BUTTON"] = "aiDefinitionsDefineButton";
+  ACTION_SUBJECT_ID["AI_DEFINITIONS_AUTO_HIGHLIGHT"] = "aiDefinitionsAutoHighlight";
   ACTION_SUBJECT_ID["ALL"] = "all";
   ACTION_SUBJECT_ID["ALT_TEXT"] = "altText";
   ACTION_SUBJECT_ID["ANNOTATE_BUTTON"] = "annotateButton";

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "94.13.1";
+const packageVersion = "94.14.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/es2019/ui/DropList/index.js

@@ -13,7 +13,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "94.13.1";
+const packageVersion = "94.14.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

package/dist/esm/analytics/types/ai-definitions-events.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/analytics/types/enums.js

@@ -260,10 +260,13 @@ export var ACTION_SUBJECT = /*#__PURE__*/function (ACTION_SUBJECT) {
   ACTION_SUBJECT["INLINE_DIALOG"] = "inlineDialog";
   ACTION_SUBJECT["ENGAGEMENT_PLATFORM"] = "engagementPlatform";
   ACTION_SUBJECT["MEDIA_VIEWER"] = "mediaViewer";
+  ACTION_SUBJECT["DECORATION"] = "decoration";
   return ACTION_SUBJECT;
 }({});
 export var ACTION_SUBJECT_ID = /*#__PURE__*/function (ACTION_SUBJECT_ID) {
   ACTION_SUBJECT_ID["ACTION"] = "action";
+  ACTION_SUBJECT_ID["AI_DEFINITIONS_DEFINE_BUTTON"] = "aiDefinitionsDefineButton";
+  ACTION_SUBJECT_ID["AI_DEFINITIONS_AUTO_HIGHLIGHT"] = "aiDefinitionsAutoHighlight";
   ACTION_SUBJECT_ID["ALL"] = "all";
   ACTION_SUBJECT_ID["ALT_TEXT"] = "altText";
   ACTION_SUBJECT_ID["ANNOTATE_BUTTON"] = "annotateButton";

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "94.13.1";
+var packageVersion = "94.14.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/esm/ui/DropList/index.js

@@ -21,7 +21,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "94.13.1";
+var packageVersion = "94.14.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/types/analytics/types/ai-definitions-events.d.ts

@@ -0,0 +1,9 @@
+import { type ACTION, type ACTION_SUBJECT, type ACTION_SUBJECT_ID } from './enums';
+import { type UIAEP } from './utils';
+type CommonAttributes = {
+    readingAidsSessionId: string;
+};
+type DefineButtonClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.BUTTON, ACTION_SUBJECT_ID.AI_DEFINITIONS_DEFINE_BUTTON, CommonAttributes, undefined>;
+type AutoHighlightClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.DECORATION, ACTION_SUBJECT_ID.AI_DEFINITIONS_AUTO_HIGHLIGHT, CommonAttributes, undefined>;
+export type AIDefinitionsEventPayload = DefineButtonClickedAEP | AutoHighlightClickedAEP;
+export {};

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

@@ -262,10 +262,13 @@ export declare enum ACTION_SUBJECT {
     CONTEXT_MENU = "contextMenu",
     INLINE_DIALOG = "inlineDialog",
     ENGAGEMENT_PLATFORM = "engagementPlatform",
-    MEDIA_VIEWER = "mediaViewer"
+    MEDIA_VIEWER = "mediaViewer",
+    DECORATION = "decoration"
 }
 export declare enum ACTION_SUBJECT_ID {
     ACTION = "action",
+    AI_DEFINITIONS_DEFINE_BUTTON = "aiDefinitionsDefineButton",
+    AI_DEFINITIONS_AUTO_HIGHLIGHT = "aiDefinitionsAutoHighlight",
     ALL = "all",
     ALT_TEXT = "altText",
     ANNOTATE_BUTTON = "annotateButton",

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

@@ -3,6 +3,7 @@ import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
 import type { EditorState, PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { NewCollabSyncUpErrorAttributes } from '../../collab';
 import type { UnsupportedContentPayload, UnsupportedContentTooltipPayload, UserBrowserExtensionResults } from '../../utils';
+import { type AIDefinitionsEventPayload } from './ai-definitions-events';
 import type { AvatarEventPayload } from './avatar';
 import type { ConfigPanelEventPayload } from './config-panel-events';
 import type { ContextMenuEventPayload } from './context-menu-events';
@@ -46,7 +47,7 @@ export type SimplifiedNode = {
     marks?: string[];
     content?: SimplifiedNode[];
 };
-export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | ContextMenuEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | MentionEventPayload | EngagementPlatformEventPayload;
+export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | ContextMenuEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | MentionEventPayload | EngagementPlatformEventPayload | AIDefinitionsEventPayload;
 type CustomPanelEventPayload = TrackAEP<ACTION.CHANGED_BACKGROUND_COLOR | ACTION.CHANGED_ICON | ACTION.REMOVE_ICON, ACTION_SUBJECT.PANEL, ACTION_SUBJECT_ID.PANEL, {
     previousColor: string;
     newColor: string;

package/dist/types-ts4.5/analytics/types/ai-definitions-events.d.ts

@@ -0,0 +1,9 @@
+import { type ACTION, type ACTION_SUBJECT, type ACTION_SUBJECT_ID } from './enums';
+import { type UIAEP } from './utils';
+type CommonAttributes = {
+    readingAidsSessionId: string;
+};
+type DefineButtonClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.BUTTON, ACTION_SUBJECT_ID.AI_DEFINITIONS_DEFINE_BUTTON, CommonAttributes, undefined>;
+type AutoHighlightClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.DECORATION, ACTION_SUBJECT_ID.AI_DEFINITIONS_AUTO_HIGHLIGHT, CommonAttributes, undefined>;
+export type AIDefinitionsEventPayload = DefineButtonClickedAEP | AutoHighlightClickedAEP;
+export {};

package/dist/types-ts4.5/analytics/types/enums.d.ts

@@ -262,10 +262,13 @@ export declare enum ACTION_SUBJECT {
     CONTEXT_MENU = "contextMenu",
     INLINE_DIALOG = "inlineDialog",
     ENGAGEMENT_PLATFORM = "engagementPlatform",
-    MEDIA_VIEWER = "mediaViewer"
+    MEDIA_VIEWER = "mediaViewer",
+    DECORATION = "decoration"
 }
 export declare enum ACTION_SUBJECT_ID {
     ACTION = "action",
+    AI_DEFINITIONS_DEFINE_BUTTON = "aiDefinitionsDefineButton",
+    AI_DEFINITIONS_AUTO_HIGHLIGHT = "aiDefinitionsAutoHighlight",
     ALL = "all",
     ALT_TEXT = "altText",
     ANNOTATE_BUTTON = "annotateButton",

package/dist/types-ts4.5/analytics/types/events.d.ts

@@ -3,6 +3,7 @@ import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
 import type { EditorState, PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { NewCollabSyncUpErrorAttributes } from '../../collab';
 import type { UnsupportedContentPayload, UnsupportedContentTooltipPayload, UserBrowserExtensionResults } from '../../utils';
+import { type AIDefinitionsEventPayload } from './ai-definitions-events';
 import type { AvatarEventPayload } from './avatar';
 import type { ConfigPanelEventPayload } from './config-panel-events';
 import type { ContextMenuEventPayload } from './context-menu-events';
@@ -46,7 +47,7 @@ export type SimplifiedNode = {
     marks?: string[];
     content?: SimplifiedNode[];
 };
-export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | ContextMenuEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | MentionEventPayload | EngagementPlatformEventPayload;
+export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | ContextMenuEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | MentionEventPayload | EngagementPlatformEventPayload | AIDefinitionsEventPayload;
 type CustomPanelEventPayload = TrackAEP<ACTION.CHANGED_BACKGROUND_COLOR | ACTION.CHANGED_ICON | ACTION.REMOVE_ICON, ACTION_SUBJECT.PANEL, ACTION_SUBJECT_ID.PANEL, {
     previousColor: string;
     newColor: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "94.13.1",
+	"version": "94.14.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"