@atlaskit/editor-plugin-media-insert 1.2.1 → 1.3.0

package/dist/es2019/plugin.js

@@ -1,17 +1,56 @@
 import React from 'react';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { toolbarInsertBlockMessages as messages } from '@atlaskit/editor-common/messages';
 import { IconImages } from '@atlaskit/editor-common/quick-insert';
-export const mediaInsertPlugin = () => {
+import { closeMediaInsertPicker, showMediaInsertPopup } from './actions';
+import { createPlugin } from './pm-plugins/main';
+import { pluginKey } from './pm-plugins/plugin-key';
+import { MediaInsertPicker } from './ui/MediaInsertPicker';
+export const mediaInsertPlugin = ({
+  api
+}) => {
   return {
     name: 'mediaInsert',
-    pmPlugins: () => [{
-      name: 'mediaInsert',
-      plugin: () => {
-        // eslint-disable-next-line no-console
-        console.log('mediaInsert plugin');
-        return undefined;
+    pmPlugins() {
+      return [{
+        name: 'mediaInsert',
+        plugin: () => createPlugin()
+      }];
+    },
+    getSharedState(editorState) {
+      if (!editorState) {
+        return {
+          isOpen: false
+        };
       }
-    }],
+      const {
+        isOpen
+      } = pluginKey.getState(editorState) || {};
+      return {
+        isOpen
+      };
+    },
+    contentComponent: ({
+      editorView,
+      dispatchAnalyticsEvent,
+      popupsMountPoint,
+      popupsBoundariesElement,
+      popupsScrollableElement
+    }) => {
+      const {
+        dispatch,
+        state
+      } = editorView;
+      return /*#__PURE__*/React.createElement(MediaInsertPicker, {
+        api: api,
+        editorView: editorView,
+        dispatchAnalyticsEvent: dispatchAnalyticsEvent,
+        popupsMountPoint: popupsMountPoint,
+        popupsBoundariesElement: popupsBoundariesElement,
+        popupsScrollableElement: popupsScrollableElement,
+        closeMediaInsertPicker: () => dispatch(closeMediaInsertPicker(state.tr))
+      });
+    },
     pluginsOptions: {
       quickInsert: ({
         formatMessage
@@ -23,10 +62,21 @@ export const mediaInsertPlugin = () => {
         keywords: ['attachment', 'gif', 'media', 'picture', 'image', 'video'],
         icon: () => /*#__PURE__*/React.createElement(IconImages, null),
         action(insert) {
-          return insert({
-            type: 'paragraph',
-            content: []
-          });
+          var _api$analytics, _api$analytics$action;
+          // Insert empty string to remove the typeahead raw text
+          // close the quick insert immediately
+          const tr = insert('');
+          showMediaInsertPopup(tr);
+          api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : (_api$analytics$action = _api$analytics.actions) === null || _api$analytics$action === void 0 ? void 0 : _api$analytics$action.attachAnalyticsEvent({
+            action: ACTION.OPENED,
+            actionSubject: ACTION_SUBJECT.PICKER,
+            actionSubjectId: ACTION_SUBJECT_ID.PICKER_MEDIA,
+            attributes: {
+              inputMethod: INPUT_METHOD.QUICK_INSERT
+            },
+            eventType: EVENT_TYPE.UI
+          })(tr);
+          return tr;
         }
       }]
     }

package/dist/es2019/pm-plugins/main.js

@@ -0,0 +1,34 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { ACTION_CLOSE_POPUP, ACTION_OPEN_POPUP } from '../actions';
+import { pluginKey } from './plugin-key';
+export const createPlugin = () => {
+  return new SafePlugin({
+    state: {
+      init() {
+        return {
+          isOpen: false
+        };
+      },
+      apply(tr, mediaInsertPluginState) {
+        const meta = tr.getMeta(pluginKey);
+        if (meta) {
+          switch (meta.type) {
+            case ACTION_OPEN_POPUP:
+              return {
+                isOpen: true
+              };
+            case ACTION_CLOSE_POPUP:
+              return {
+                isOpen: false
+              };
+            default:
+              return mediaInsertPluginState;
+          }
+        } else {
+          return mediaInsertPluginState;
+        }
+      }
+    },
+    key: pluginKey
+  });
+};

package/dist/es2019/pm-plugins/plugin-key.js

@@ -0,0 +1,2 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export const pluginKey = new PluginKey('mediaInsertPlugin');

package/dist/es2019/types.js

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

package/dist/es2019/ui/FromURL.js

@@ -79,20 +79,15 @@ export function MediaFromURL({
     errorMessage: intl.formatMessage(mediaInsertMessages.errorMessage),
     warning: intl.formatMessage(mediaInsertMessages.warning)
   };
-  const [url, setUrl] = React.useState(placeholders[1]);
+  const [inputUrl, setUrl] = React.useState(placeholders[1]);
   const [previewState, dispatch] = React.useReducer(previewStateReducer, INITIAL_PREVIEW_STATE);
+  const pasteFlag = React.useRef(false);
   const {
     onUploadAnalytics,
     onUploadSuccessAnalytics,
     onUploadFailureAnalytics
   } = useAnalyticsEvents(dispatchAnalyticsEvent);
-  const onURLChange = React.useCallback(e => {
-    setUrl(e.target.value);
-    dispatch({
-      type: 'reset'
-    });
-  }, []);
-  const uploadExternalMedia = React.useCallback(async () => {
+  const uploadExternalMedia = React.useCallback(async url => {
     dispatch({
       type: 'loading'
     });
@@ -131,7 +126,7 @@ export function MediaFromURL({
         dispatch({
           type: 'warning',
           warning: e,
-          url
+          url: inputUrl
         });
       } else if (e instanceof Error) {
         const message = 'Image preview fetch failed';
@@ -148,27 +143,50 @@ export function MediaFromURL({
         });
       }
     }
-  }, [mediaProvider, onUploadAnalytics, onUploadFailureAnalytics, onUploadSuccessAnalytics, url]);
+  }, [mediaProvider, onUploadAnalytics, onUploadFailureAnalytics, onUploadSuccessAnalytics, inputUrl]);
+  const onURLChange = React.useCallback(e => {
+    const url = e.target.value;
+    setUrl(url);
+    dispatch({
+      type: 'reset'
+    });
+    if (pasteFlag.current === true) {
+      pasteFlag.current = false;
+      uploadExternalMedia(url);
+    }
+  }, [uploadExternalMedia]);
+  const onPaste = React.useCallback(e => {
+    // Note: this is a little weird, but the paste event will always be
+    // fired before the change event when pasting. We don't really want to
+    // duplicate logic by handling pastes separately to changes, so we're
+    // just noting paste occured to then be handled in the onURLChange fn
+    // above. The one exception to this is where paste inputs exactly what was
+    // already in the input, in which case we want to ignore it.
+    if (e.clipboardData.getData('text') !== inputUrl) {
+      pasteFlag.current = true;
+    }
+  }, [inputUrl]);
   const onInsertClick = React.useCallback(() => {
     if (previewState.previewInfo) {
       return onInsert(previewState.previewInfo);
     }
     if (previewState.warning) {
-      return onExternalInsert(url);
+      return onExternalInsert(inputUrl);
     }
-  }, [onExternalInsert, onInsert, previewState.previewInfo, previewState.warning, url]);
+  }, [onExternalInsert, onInsert, previewState.previewInfo, previewState.warning, inputUrl]);
   return /*#__PURE__*/React.createElement("form", {
     onSubmit: e => {
       e.preventDefault();
-      uploadExternalMedia();
+      uploadExternalMedia(inputUrl);
     }
   }, /*#__PURE__*/React.createElement(Stack, {
     space: "space.150"
   }, /*#__PURE__*/React.createElement(TextField, {
     autoFocus: true,
-    value: url,
+    value: inputUrl,
     placeholder: strings.pasteLinkToUpload,
-    onChange: onURLChange
+    onChange: onURLChange,
+    onPaste: onPaste
   }), previewState.previewInfo && /*#__PURE__*/React.createElement(Inline, {
     alignInline: "center",
     alignBlock: "center",
@@ -188,7 +206,7 @@ export function MediaFromURL({
   }, /*#__PURE__*/React.createElement(Button, {
     type: "submit",
     isLoading: previewState.isLoading,
-    isDisabled: !url,
+    isDisabled: !inputUrl,
     iconBefore: EditorFilePreviewIcon
   }, strings.loadPreview)), /*#__PURE__*/React.createElement(Box, {
     xcss: ButtonGroupStyles

package/dist/es2019/ui/MediaInsertContent.js

@@ -0,0 +1,14 @@
+import React from 'react';
+import Button from '@atlaskit/button/new';
+import { Box } from '@atlaskit/primitives';
+import Tabs, { Tab, TabList, TabPanel } from '@atlaskit/tabs';
+export const MediaInsertContent = () => {
+  return /*#__PURE__*/React.createElement(Tabs, {
+    id: "media-insert-tab-navigation"
+  }, /*#__PURE__*/React.createElement(Box, {
+    paddingBlockEnd: "space.150"
+  }, /*#__PURE__*/React.createElement(TabList, null, /*#__PURE__*/React.createElement(Tab, null, /*#__PURE__*/React.createElement(Button, {
+    autoFocus: true,
+    appearance: "subtle"
+  }, "Link")))), /*#__PURE__*/React.createElement(TabPanel, null, /*#__PURE__*/React.createElement("p", null, "InsertLinkPanel here")));
+};

package/dist/es2019/ui/MediaInsertPicker.js

@@ -0,0 +1,79 @@
+import React from 'react';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+import { Popup, withOuterListeners } from '@atlaskit/editor-common/ui';
+import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
+import { akEditorFloatingDialogZIndex } from '@atlaskit/editor-shared-styles';
+import { MediaInsertContent } from './MediaInsertContent';
+import { MediaInsertWrapper } from './MediaInsertWrapper';
+const PopupWithListeners = withOuterListeners(Popup);
+const getDomRefFromSelection = (view, dispatchAnalyticsEvent) => {
+  try {
+    const domRef = findDomRefAtPos(view.state.selection.from, view.domAtPos.bind(view));
+    if (domRef instanceof HTMLElement) {
+      return domRef;
+    } else {
+      throw new Error('Invalid DOM reference');
+    }
+  } catch (error) {
+    if (dispatchAnalyticsEvent) {
+      const payload = {
+        action: ACTION.ERRORED,
+        actionSubject: ACTION_SUBJECT.PICKER,
+        actionSubjectId: ACTION_SUBJECT_ID.PICKER_MEDIA,
+        eventType: EVENT_TYPE.OPERATIONAL,
+        attributes: {
+          error: 'Error getting DOM reference from selection'
+        }
+      };
+      dispatchAnalyticsEvent(payload);
+    }
+  }
+};
+export const MediaInsertPicker = ({
+  api,
+  editorView,
+  dispatchAnalyticsEvent,
+  popupsMountPoint,
+  popupsBoundariesElement,
+  popupsScrollableElement,
+  closeMediaInsertPicker
+}) => {
+  const targetRef = getDomRefFromSelection(editorView, dispatchAnalyticsEvent);
+  const {
+    mediaInsertState
+  } = useSharedPluginState(api, ['mediaInsert']);
+  if (!mediaInsertState || !mediaInsertState.isOpen) {
+    return null;
+  }
+  const handleClose = exitMethod => event => {
+    event.preventDefault();
+    if (dispatchAnalyticsEvent) {
+      const payload = {
+        action: ACTION.CLOSED,
+        actionSubject: ACTION_SUBJECT.PICKER,
+        actionSubjectId: ACTION_SUBJECT_ID.PICKER_MEDIA,
+        eventType: EVENT_TYPE.UI,
+        attributes: {
+          exitMethod
+        }
+      };
+      dispatchAnalyticsEvent(payload);
+    }
+    closeMediaInsertPicker();
+  };
+  return /*#__PURE__*/React.createElement(PopupWithListeners
+  // TODO: i18n
+  , {
+    ariaLabel: 'Media Insert',
+    offset: [0, 12],
+    target: targetRef,
+    zIndex: akEditorFloatingDialogZIndex,
+    mountTo: popupsMountPoint,
+    boundariesElement: popupsBoundariesElement,
+    handleClickOutside: handleClose(INPUT_METHOD.MOUSE),
+    handleEscapeKeydown: handleClose(INPUT_METHOD.KEYBOARD),
+    scrollableElement: popupsScrollableElement,
+    focusTrap: true
+  }, /*#__PURE__*/React.createElement(MediaInsertWrapper, null, /*#__PURE__*/React.createElement(MediaInsertContent, null)));
+};

package/dist/es2019/ui/MediaInsertWrapper.js

@@ -0,0 +1,15 @@
+import React from 'react';
+import { Box, xcss } from '@atlaskit/primitives';
+const styles = xcss({
+  boxShadow: 'elevation.shadow.overflow',
+  width: '340px',
+  padding: 'space.200',
+  borderRadius: 'border.radius'
+});
+export const MediaInsertWrapper = ({
+  children
+}) => {
+  return /*#__PURE__*/React.createElement(Box, {
+    xcss: styles
+  }, children);
+};

package/dist/esm/actions.js

@@ -0,0 +1,22 @@
+import { pluginKey } from './pm-plugins/plugin-key';
+export var ACTION_OPEN_POPUP = 'OPEN_POPUP';
+export var ACTION_CLOSE_POPUP = 'CLOSE_POPUP';
+var setPopupMeta = function setPopupMeta(_ref) {
+  var type = _ref.type,
+    tr = _ref.tr;
+  return tr.setMeta(pluginKey, {
+    type: type
+  });
+};
+export var showMediaInsertPopup = function showMediaInsertPopup(tr) {
+  return setPopupMeta({
+    type: ACTION_OPEN_POPUP,
+    tr: tr
+  });
+};
+export var closeMediaInsertPicker = function closeMediaInsertPicker(tr) {
+  return setPopupMeta({
+    type: ACTION_CLOSE_POPUP,
+    tr: tr
+  });
+};

package/dist/esm/plugin.js

@@ -1,22 +1,58 @@
 import React from 'react';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { toolbarInsertBlockMessages as messages } from '@atlaskit/editor-common/messages';
 import { IconImages } from '@atlaskit/editor-common/quick-insert';
-export var mediaInsertPlugin = function mediaInsertPlugin() {
+import { closeMediaInsertPicker as _closeMediaInsertPicker, showMediaInsertPopup } from './actions';
+import { createPlugin } from './pm-plugins/main';
+import { pluginKey } from './pm-plugins/plugin-key';
+import { MediaInsertPicker } from './ui/MediaInsertPicker';
+export var mediaInsertPlugin = function mediaInsertPlugin(_ref) {
+  var api = _ref.api;
   return {
     name: 'mediaInsert',
     pmPlugins: function pmPlugins() {
       return [{
         name: 'mediaInsert',
         plugin: function plugin() {
-          // eslint-disable-next-line no-console
-          console.log('mediaInsert plugin');
-          return undefined;
+          return createPlugin();
         }
       }];
     },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return {
+          isOpen: false
+        };
+      }
+      var _ref2 = pluginKey.getState(editorState) || {},
+        isOpen = _ref2.isOpen;
+      return {
+        isOpen: isOpen
+      };
+    },
+    contentComponent: function contentComponent(_ref3) {
+      var editorView = _ref3.editorView,
+        dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent,
+        popupsMountPoint = _ref3.popupsMountPoint,
+        popupsBoundariesElement = _ref3.popupsBoundariesElement,
+        popupsScrollableElement = _ref3.popupsScrollableElement;
+      var dispatch = editorView.dispatch,
+        state = editorView.state;
+      return /*#__PURE__*/React.createElement(MediaInsertPicker, {
+        api: api,
+        editorView: editorView,
+        dispatchAnalyticsEvent: dispatchAnalyticsEvent,
+        popupsMountPoint: popupsMountPoint,
+        popupsBoundariesElement: popupsBoundariesElement,
+        popupsScrollableElement: popupsScrollableElement,
+        closeMediaInsertPicker: function closeMediaInsertPicker() {
+          return dispatch(_closeMediaInsertPicker(state.tr));
+        }
+      });
+    },
     pluginsOptions: {
-      quickInsert: function quickInsert(_ref) {
-        var formatMessage = _ref.formatMessage;
+      quickInsert: function quickInsert(_ref4) {
+        var formatMessage = _ref4.formatMessage;
         return [{
           id: 'media-insert',
           title: formatMessage(messages.insertMediaFromUrl),
@@ -27,10 +63,21 @@ export var mediaInsertPlugin = function mediaInsertPlugin() {
             return /*#__PURE__*/React.createElement(IconImages, null);
           },
           action: function action(insert) {
-            return insert({
-              type: 'paragraph',
-              content: []
-            });
+            var _api$analytics;
+            // Insert empty string to remove the typeahead raw text
+            // close the quick insert immediately
+            var tr = insert('');
+            showMediaInsertPopup(tr);
+            api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 || _api$analytics.attachAnalyticsEvent({
+              action: ACTION.OPENED,
+              actionSubject: ACTION_SUBJECT.PICKER,
+              actionSubjectId: ACTION_SUBJECT_ID.PICKER_MEDIA,
+              attributes: {
+                inputMethod: INPUT_METHOD.QUICK_INSERT
+              },
+              eventType: EVENT_TYPE.UI
+            })(tr);
+            return tr;
           }
         }];
       }

package/dist/esm/pm-plugins/main.js

@@ -0,0 +1,34 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { ACTION_CLOSE_POPUP, ACTION_OPEN_POPUP } from '../actions';
+import { pluginKey } from './plugin-key';
+export var createPlugin = function createPlugin() {
+  return new SafePlugin({
+    state: {
+      init: function init() {
+        return {
+          isOpen: false
+        };
+      },
+      apply: function apply(tr, mediaInsertPluginState) {
+        var meta = tr.getMeta(pluginKey);
+        if (meta) {
+          switch (meta.type) {
+            case ACTION_OPEN_POPUP:
+              return {
+                isOpen: true
+              };
+            case ACTION_CLOSE_POPUP:
+              return {
+                isOpen: false
+              };
+            default:
+              return mediaInsertPluginState;
+          }
+        } else {
+          return mediaInsertPluginState;
+        }
+      }
+    },
+    key: pluginKey
+  });
+};

package/dist/esm/pm-plugins/plugin-key.js

@@ -0,0 +1,2 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export var pluginKey = new PluginKey('mediaInsertPlugin');

package/dist/esm/types.js

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