@atlaskit/editor-plugin-media-insert 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/editor-plugin-media-insert
 
+## 2.0.1
+
+### Patch Changes
+
+- [#130061](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/130061)
+  [`bdad694cb2c24`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/bdad694cb2c24) -
+  [ux] [ED-24566] **@atlaskit/editor-plugin-media-insert**: When user clicks "Cancel" button on
+  insert media popup the focus is returned to the editor **@atlaskit/editor-common**: Added event
+  type for media insert cancelled analytics
+
 ## 2.0.0
 
 ### Major Changes

package/dist/cjs/ui/FromURL.js

@@ -13,6 +13,7 @@ var _react = _interopRequireDefault(require("react"));
 var _reactIntlNext = require("react-intl-next");
 var _buttonGroup = _interopRequireDefault(require("@atlaskit/button/button-group"));
 var _new = _interopRequireDefault(require("@atlaskit/button/new"));
+var _analytics = require("@atlaskit/editor-common/analytics");
 var _messages = require("@atlaskit/editor-common/messages");
 var _filePreview = _interopRequireDefault(require("@atlaskit/icon/glyph/editor/file-preview"));
 var _mediaClientReact = require("@atlaskit/media-client-react");
@@ -81,7 +82,7 @@ function MediaFromURL(_ref) {
     onInsert = _ref.onInsert,
     onExternalInsert = _ref.onExternalInsert,
     dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    onEscKeyPressed = _ref.onEscKeyPressed;
+    closeMediaInsertPicker = _ref.closeMediaInsertPicker;
   var intl = (0, _reactIntlNext.useIntl)();
   var strings = {
     loadPreview: intl.formatMessage(_messages.mediaInsertMessages.loadPreview),
@@ -212,9 +213,33 @@ function MediaFromURL(_ref) {
   }, [onExternalInsert, onInsert, previewState.previewInfo, previewState.warning, inputUrl]);
   var onInputKeyPress = _react.default.useCallback(function (event) {
     if (event && event.key === 'Esc') {
-      onEscKeyPressed();
+      if (dispatchAnalyticsEvent) {
+        var payload = {
+          action: _analytics.ACTION.CLOSED,
+          actionSubject: _analytics.ACTION_SUBJECT.PICKER,
+          actionSubjectId: _analytics.ACTION_SUBJECT_ID.PICKER_MEDIA,
+          eventType: _analytics.EVENT_TYPE.UI,
+          attributes: {
+            exitMethod: _analytics.INPUT_METHOD.KEYBOARD
+          }
+        };
+        dispatchAnalyticsEvent(payload);
+      }
+      closeMediaInsertPicker();
     }
-  }, [onEscKeyPressed]);
+  }, [dispatchAnalyticsEvent, closeMediaInsertPicker]);
+  var onCancel = _react.default.useCallback(function () {
+    if (dispatchAnalyticsEvent) {
+      var payload = {
+        action: _analytics.ACTION.CANCELLED,
+        actionSubject: _analytics.ACTION_SUBJECT.PICKER,
+        actionSubjectId: _analytics.ACTION_SUBJECT_ID.PICKER_MEDIA,
+        eventType: _analytics.EVENT_TYPE.UI
+      };
+      dispatchAnalyticsEvent(payload);
+    }
+    closeMediaInsertPicker();
+  }, [closeMediaInsertPicker, dispatchAnalyticsEvent]);
   return /*#__PURE__*/_react.default.createElement(_primitives.Box, {
     as: "form",
     onSubmit: function onSubmit(e) {
@@ -256,7 +281,8 @@ function MediaFromURL(_ref) {
   }, strings.loadPreview)), /*#__PURE__*/_react.default.createElement(_primitives.Box, {
     xcss: ButtonGroupStyles
   }, /*#__PURE__*/_react.default.createElement(_buttonGroup.default, null, /*#__PURE__*/_react.default.createElement(_new.default, {
-    appearance: "subtle"
+    appearance: "subtle",
+    onClick: onCancel
   }, strings.cancel), /*#__PURE__*/_react.default.createElement(_new.default, {
     appearance: "primary",
     isDisabled: !previewState.previewInfo && !previewState.warning,

package/dist/cjs/ui/MediaInsertContent.js

@@ -15,7 +15,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
 var MediaInsertContent = exports.MediaInsertContent = function MediaInsertContent(_ref) {
   var mediaProvider = _ref.mediaProvider,
     dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    onEscKeyPressed = _ref.onEscKeyPressed;
+    closeMediaInsertPicker = _ref.closeMediaInsertPicker;
   return /*#__PURE__*/_react.default.createElement(_tabs.default, {
     id: "media-insert-tab-navigation"
   }, /*#__PURE__*/_react.default.createElement(_primitives.Box, {
@@ -25,6 +25,6 @@ var MediaInsertContent = exports.MediaInsertContent = function MediaInsertConten
     onExternalInsert: function onExternalInsert() {},
     onInsert: function onInsert() {},
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    onEscKeyPressed: onEscKeyPressed
+    closeMediaInsertPicker: closeMediaInsertPicker
   })));
 };

package/dist/cjs/ui/MediaInsertPicker.js

@@ -89,8 +89,6 @@ var MediaInsertPicker = exports.MediaInsertPicker = function MediaInsertPicker(_
   }, /*#__PURE__*/_react.default.createElement(_MediaInsertWrapper.MediaInsertWrapper, null, /*#__PURE__*/_react.default.createElement(_MediaInsertContent.MediaInsertContent, {
     mediaProvider: mediaProvider,
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    onEscKeyPressed: function onEscKeyPressed() {
-      return handleClose(_analytics.INPUT_METHOD.KEYBOARD);
-    }
+    closeMediaInsertPicker: closeMediaInsertPicker
   })));
 };

package/dist/es2019/ui/FromURL.js

@@ -2,6 +2,7 @@ import React from 'react';
 import { useIntl } from 'react-intl-next';
 import ButtonGroup from '@atlaskit/button/button-group';
 import Button from '@atlaskit/button/new';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { mediaInsertMessages } from '@atlaskit/editor-common/messages';
 import EditorFilePreviewIcon from '@atlaskit/icon/glyph/editor/file-preview';
 import { getMediaClient } from '@atlaskit/media-client-react';
@@ -72,7 +73,7 @@ export function MediaFromURL({
   onInsert,
   onExternalInsert,
   dispatchAnalyticsEvent,
-  onEscKeyPressed
+  closeMediaInsertPicker
 }) {
   const intl = useIntl();
   const strings = {
@@ -180,9 +181,33 @@ export function MediaFromURL({
   }, [onExternalInsert, onInsert, previewState.previewInfo, previewState.warning, inputUrl]);
   const onInputKeyPress = React.useCallback(event => {
     if (event && event.key === 'Esc') {
-      onEscKeyPressed();
+      if (dispatchAnalyticsEvent) {
+        const payload = {
+          action: ACTION.CLOSED,
+          actionSubject: ACTION_SUBJECT.PICKER,
+          actionSubjectId: ACTION_SUBJECT_ID.PICKER_MEDIA,
+          eventType: EVENT_TYPE.UI,
+          attributes: {
+            exitMethod: INPUT_METHOD.KEYBOARD
+          }
+        };
+        dispatchAnalyticsEvent(payload);
+      }
+      closeMediaInsertPicker();
+    }
+  }, [dispatchAnalyticsEvent, closeMediaInsertPicker]);
+  const onCancel = React.useCallback(() => {
+    if (dispatchAnalyticsEvent) {
+      const payload = {
+        action: ACTION.CANCELLED,
+        actionSubject: ACTION_SUBJECT.PICKER,
+        actionSubjectId: ACTION_SUBJECT_ID.PICKER_MEDIA,
+        eventType: EVENT_TYPE.UI
+      };
+      dispatchAnalyticsEvent(payload);
     }
-  }, [onEscKeyPressed]);
+    closeMediaInsertPicker();
+  }, [closeMediaInsertPicker, dispatchAnalyticsEvent]);
   return /*#__PURE__*/React.createElement(Box, {
     as: "form",
     onSubmit: e => {
@@ -224,7 +249,8 @@ export function MediaFromURL({
   }, strings.loadPreview)), /*#__PURE__*/React.createElement(Box, {
     xcss: ButtonGroupStyles
   }, /*#__PURE__*/React.createElement(ButtonGroup, null, /*#__PURE__*/React.createElement(Button, {
-    appearance: "subtle"
+    appearance: "subtle",
+    onClick: onCancel
   }, strings.cancel), /*#__PURE__*/React.createElement(Button, {
     appearance: "primary",
     isDisabled: !previewState.previewInfo && !previewState.warning,

package/dist/es2019/ui/MediaInsertContent.js

@@ -5,7 +5,7 @@ import { MediaFromURL } from './FromURL';
 export const MediaInsertContent = ({
   mediaProvider,
   dispatchAnalyticsEvent,
-  onEscKeyPressed
+  closeMediaInsertPicker
 }) => {
   return /*#__PURE__*/React.createElement(Tabs, {
     id: "media-insert-tab-navigation"
@@ -16,6 +16,6 @@ export const MediaInsertContent = ({
     onExternalInsert: () => {},
     onInsert: () => {},
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    onEscKeyPressed: onEscKeyPressed
+    closeMediaInsertPicker: closeMediaInsertPicker
   })));
 };

package/dist/es2019/ui/MediaInsertPicker.js

@@ -81,6 +81,6 @@ export const MediaInsertPicker = ({
   }, /*#__PURE__*/React.createElement(MediaInsertWrapper, null, /*#__PURE__*/React.createElement(MediaInsertContent, {
     mediaProvider: mediaProvider,
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    onEscKeyPressed: () => handleClose(INPUT_METHOD.KEYBOARD)
+    closeMediaInsertPicker: closeMediaInsertPicker
   })));
 };

package/dist/esm/ui/FromURL.js

@@ -8,6 +8,7 @@ import React from 'react';
 import { useIntl } from 'react-intl-next';
 import ButtonGroup from '@atlaskit/button/button-group';
 import Button from '@atlaskit/button/new';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { mediaInsertMessages } from '@atlaskit/editor-common/messages';
 import EditorFilePreviewIcon from '@atlaskit/icon/glyph/editor/file-preview';
 import { getMediaClient } from '@atlaskit/media-client-react';
@@ -74,7 +75,7 @@ export function MediaFromURL(_ref) {
     onInsert = _ref.onInsert,
     onExternalInsert = _ref.onExternalInsert,
     dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    onEscKeyPressed = _ref.onEscKeyPressed;
+    closeMediaInsertPicker = _ref.closeMediaInsertPicker;
   var intl = useIntl();
   var strings = {
     loadPreview: intl.formatMessage(mediaInsertMessages.loadPreview),
@@ -205,9 +206,33 @@ export function MediaFromURL(_ref) {
   }, [onExternalInsert, onInsert, previewState.previewInfo, previewState.warning, inputUrl]);
   var onInputKeyPress = React.useCallback(function (event) {
     if (event && event.key === 'Esc') {
-      onEscKeyPressed();
+      if (dispatchAnalyticsEvent) {
+        var payload = {
+          action: ACTION.CLOSED,
+          actionSubject: ACTION_SUBJECT.PICKER,
+          actionSubjectId: ACTION_SUBJECT_ID.PICKER_MEDIA,
+          eventType: EVENT_TYPE.UI,
+          attributes: {
+            exitMethod: INPUT_METHOD.KEYBOARD
+          }
+        };
+        dispatchAnalyticsEvent(payload);
+      }
+      closeMediaInsertPicker();
     }
-  }, [onEscKeyPressed]);
+  }, [dispatchAnalyticsEvent, closeMediaInsertPicker]);
+  var onCancel = React.useCallback(function () {
+    if (dispatchAnalyticsEvent) {
+      var payload = {
+        action: ACTION.CANCELLED,
+        actionSubject: ACTION_SUBJECT.PICKER,
+        actionSubjectId: ACTION_SUBJECT_ID.PICKER_MEDIA,
+        eventType: EVENT_TYPE.UI
+      };
+      dispatchAnalyticsEvent(payload);
+    }
+    closeMediaInsertPicker();
+  }, [closeMediaInsertPicker, dispatchAnalyticsEvent]);
   return /*#__PURE__*/React.createElement(Box, {
     as: "form",
     onSubmit: function onSubmit(e) {
@@ -249,7 +274,8 @@ export function MediaFromURL(_ref) {
   }, strings.loadPreview)), /*#__PURE__*/React.createElement(Box, {
     xcss: ButtonGroupStyles
   }, /*#__PURE__*/React.createElement(ButtonGroup, null, /*#__PURE__*/React.createElement(Button, {
-    appearance: "subtle"
+    appearance: "subtle",
+    onClick: onCancel
   }, strings.cancel), /*#__PURE__*/React.createElement(Button, {
     appearance: "primary",
     isDisabled: !previewState.previewInfo && !previewState.warning,

package/dist/esm/ui/MediaInsertContent.js

@@ -5,7 +5,7 @@ import { MediaFromURL } from './FromURL';
 export var MediaInsertContent = function MediaInsertContent(_ref) {
   var mediaProvider = _ref.mediaProvider,
     dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    onEscKeyPressed = _ref.onEscKeyPressed;
+    closeMediaInsertPicker = _ref.closeMediaInsertPicker;
   return /*#__PURE__*/React.createElement(Tabs, {
     id: "media-insert-tab-navigation"
   }, /*#__PURE__*/React.createElement(Box, {
@@ -15,6 +15,6 @@ export var MediaInsertContent = function MediaInsertContent(_ref) {
     onExternalInsert: function onExternalInsert() {},
     onInsert: function onInsert() {},
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    onEscKeyPressed: onEscKeyPressed
+    closeMediaInsertPicker: closeMediaInsertPicker
   })));
 };

package/dist/esm/ui/MediaInsertPicker.js

@@ -82,8 +82,6 @@ export var MediaInsertPicker = function MediaInsertPicker(_ref) {
   }, /*#__PURE__*/React.createElement(MediaInsertWrapper, null, /*#__PURE__*/React.createElement(MediaInsertContent, {
     mediaProvider: mediaProvider,
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    onEscKeyPressed: function onEscKeyPressed() {
-      return handleClose(INPUT_METHOD.KEYBOARD);
-    }
+    closeMediaInsertPicker: closeMediaInsertPicker
   })));
 };

package/dist/types/ui/FromURL.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
+import { type DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { MediaProvider } from '@atlaskit/editor-common/provider-factory';
 import { type OnInsertAttrs } from './types';
 type Props = {
@@ -7,7 +7,7 @@ type Props = {
     onInsert: (attrs: OnInsertAttrs) => void;
     onExternalInsert: (url: string) => void;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
-    onEscKeyPressed: () => void;
+    closeMediaInsertPicker: () => void;
 };
-export declare function MediaFromURL({ mediaProvider, onInsert, onExternalInsert, dispatchAnalyticsEvent, onEscKeyPressed, }: Props): JSX.Element;
+export declare function MediaFromURL({ mediaProvider, onInsert, onExternalInsert, dispatchAnalyticsEvent, closeMediaInsertPicker, }: Props): JSX.Element;
 export {};

package/dist/types/ui/MediaInsertContent.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { MediaProvider } from '@atlaskit/editor-common/provider-factory';
-export declare const MediaInsertContent: ({ mediaProvider, dispatchAnalyticsEvent, onEscKeyPressed, }: {
+export declare const MediaInsertContent: ({ mediaProvider, dispatchAnalyticsEvent, closeMediaInsertPicker, }: {
     mediaProvider: MediaProvider;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent | undefined;
-    onEscKeyPressed: () => void;
+    closeMediaInsertPicker: () => void;
 }) => JSX.Element;

package/dist/types-ts4.5/ui/FromURL.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
+import { type DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { MediaProvider } from '@atlaskit/editor-common/provider-factory';
 import { type OnInsertAttrs } from './types';
 type Props = {
@@ -7,7 +7,7 @@ type Props = {
     onInsert: (attrs: OnInsertAttrs) => void;
     onExternalInsert: (url: string) => void;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
-    onEscKeyPressed: () => void;
+    closeMediaInsertPicker: () => void;
 };
-export declare function MediaFromURL({ mediaProvider, onInsert, onExternalInsert, dispatchAnalyticsEvent, onEscKeyPressed, }: Props): JSX.Element;
+export declare function MediaFromURL({ mediaProvider, onInsert, onExternalInsert, dispatchAnalyticsEvent, closeMediaInsertPicker, }: Props): JSX.Element;
 export {};

package/dist/types-ts4.5/ui/MediaInsertContent.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { MediaProvider } from '@atlaskit/editor-common/provider-factory';
-export declare const MediaInsertContent: ({ mediaProvider, dispatchAnalyticsEvent, onEscKeyPressed, }: {
+export declare const MediaInsertContent: ({ mediaProvider, dispatchAnalyticsEvent, closeMediaInsertPicker, }: {
     mediaProvider: MediaProvider;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent | undefined;
-    onEscKeyPressed: () => void;
+    closeMediaInsertPicker: () => void;
 }) => JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-media-insert",
-	"version": "2.0.0",
+	"version": "2.0.1",
 	"description": "Media Insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",