@atlaskit/editor-plugin-emoji 7.1.1 → 7.2.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/editor-plugin-emoji
 
+## 7.2.0
+
+### Minor Changes
+
+- [`3a08cc16abe76`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3a08cc16abe76) -
+  [https://product-fabric.atlassian.net/browse/ED-29521](ED-29521) - use optimistic image URL for
+  emojis in editor (client support)
+
+### Patch Changes
+
+- Updated dependencies
+
+## 7.1.2
+
+### Patch Changes
+
+- [`0b4cd77e72217`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0b4cd77e72217) -
+  clean up references to platform_editor_controls_performance_fixes
+- Updated dependencies
+
 ## 7.1.1
 
 ### Patch Changes

package/dist/cjs/emojiPlugin.js

@@ -318,18 +318,6 @@ var emojiPlugin = exports.emojiPlugin = function emojiPlugin(_ref2) {
       if (!api || (0, _experiments.editorExperiment)('platform_editor_controls', 'control') || !editorView) {
         return null;
       }
-      if (!(0, _experiments.editorExperiment)('platform_editor_controls_performance_fixes', true)) {
-        return /*#__PURE__*/_react.default.createElement(_InlineEmojiPopup.InlineEmojiPopupOld, {
-          api: api,
-          editorView: editorView,
-          popupsBoundariesElement: popupsBoundariesElement,
-          popupsMountPoint: popupsMountPoint,
-          popupsScrollableElement: popupsScrollableElement,
-          onClose: function onClose() {
-            return editorView.dispatch((0, _actions.setInlineEmojiPopupOpen)(false)(editorView.state.tr));
-          }
-        });
-      }
       return /*#__PURE__*/_react.default.createElement(_InlineEmojiPopup.InlineEmojiPopup, {
         api: api,
         editorView: editorView,

package/dist/cjs/pm-plugins/providers/EmojiNodeDataProvider.js

@@ -13,8 +13,11 @@ var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _coreUtils = require("@atlaskit/editor-common/core-utils");
 var _emoji = require("@atlaskit/emoji");
 var _nodeDataProvider = require("@atlaskit/node-data-provider");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 var EmojiNodeDataProvider = exports.EmojiNodeDataProvider = /*#__PURE__*/function (_NodeDataProvider) {
@@ -42,24 +45,27 @@ var EmojiNodeDataProvider = exports.EmojiNodeDataProvider = /*#__PURE__*/functio
   }, {
     key: "fetchNodesData",
     value: function () {
-      var _fetchNodesData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(nodes) {
+      var _fetchNodesData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(nodes) {
         var _this$emojiResource$e;
         var getOptimisticImageUrl, emojiProvider, fetches;
-        return _regenerator.default.wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
             case 0:
               // If we have an `optimisticImageApi`, use it to generate a URL immediately.
               // This is how emojis are server-side rendered in Confluence.
               // Without this, the emoji server response will hit timeout on SSR and the emoji will not be rendered.
               //
+              // We are using this optimization only in SSR because on client side we need to know a valid emoji size
+              // which is not possible to get from optimisticImageApi.
+              //
               // Check platform/packages/editor/renderer/src/react/nodes/emoji.tsx
               // and platform/packages/elements/emoji/src/components/common/ResourcedEmojiComponent.tsx
               getOptimisticImageUrl = (_this$emojiResource$e = this.emojiResource.emojiProviderConfig.optimisticImageApi) === null || _this$emojiResource$e === void 0 ? void 0 : _this$emojiResource$e.getUrl;
-              if (!getOptimisticImageUrl) {
-                _context.next = 3;
+              if (!((0, _coreUtils.isSSR)() && getOptimisticImageUrl)) {
+                _context2.next = 3;
                 break;
               }
-              return _context.abrupt("return", nodes.map(function (node) {
+              return _context2.abrupt("return", nodes.map(function (node) {
                 var emojiId = {
                   id: node.attrs.id,
                   shortName: node.attrs.shortName,
@@ -83,26 +89,57 @@ var EmojiNodeDataProvider = exports.EmojiNodeDataProvider = /*#__PURE__*/functio
                 };
               }));
             case 3:
-              _context.next = 5;
+              _context2.next = 5;
               return this.emojiProvider;
             case 5:
-              emojiProvider = _context.sent;
-              fetches = nodes.map(function (node) {
-                var emojiId = {
-                  id: node.attrs.id,
-                  shortName: node.attrs.shortName,
-                  fallback: node.attrs.text
+              emojiProvider = _context2.sent;
+              fetches = nodes.map( /*#__PURE__*/function () {
+                var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(node) {
+                  var emojiId, result, optimisticImageURL;
+                  return _regenerator.default.wrap(function _callee$(_context) {
+                    while (1) switch (_context.prev = _context.next) {
+                      case 0:
+                        emojiId = {
+                          id: node.attrs.id,
+                          shortName: node.attrs.shortName,
+                          fallback: node.attrs.text
+                        }; // This usually fast because the emojiProvider already has all emojis fetched.
+                        _context.next = 3;
+                        return emojiProvider.fetchByEmojiId(emojiId, true);
+                      case 3:
+                        result = _context.sent;
+                        if (!(getOptimisticImageUrl && result)) {
+                          _context.next = 8;
+                          break;
+                        }
+                        optimisticImageURL = getOptimisticImageUrl(emojiId);
+                        if (!(result.representation && 'imagePath' in result.representation)) {
+                          _context.next = 8;
+                          break;
+                        }
+                        return _context.abrupt("return", _objectSpread(_objectSpread({}, result), {}, {
+                          representation: _objectSpread(_objectSpread({}, result.representation), {}, {
+                            imagePath: optimisticImageURL
+                          })
+                        }));
+                      case 8:
+                        return _context.abrupt("return", result);
+                      case 9:
+                      case "end":
+                        return _context.stop();
+                    }
+                  }, _callee);
+                }));
+                return function (_x2) {
+                  return _ref.apply(this, arguments);
                 };
-
-                // This usually fast because the emojiProvider already has all emojis fetched.
-                return emojiProvider.fetchByEmojiId(emojiId, true);
-              });
-              return _context.abrupt("return", Promise.all(fetches));
+              }());
+              return _context2.abrupt("return", Promise.all(fetches));
             case 8:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
-        }, _callee, this);
+        }, _callee2, this);
       }));
       function fetchNodesData(_x) {
         return _fetchNodesData.apply(this, arguments);

package/dist/es2019/emojiPlugin.js

@@ -17,7 +17,7 @@ import { emojiNodeSpec } from './nodeviews/emojiNodeSpec';
 import { EmojiNodeView } from './nodeviews/EmojiNodeView';
 import { ACTIONS, openTypeAhead as openTypeAheadAction, setAsciiMap as setAsciiMapAction, setInlineEmojiPopupOpen, setProvider as setProviderAction } from './pm-plugins/actions';
 import { inputRulePlugin as asciiInputRulePlugin } from './pm-plugins/ascii-input-rules';
-import { InlineEmojiPopup, InlineEmojiPopupOld } from './ui/InlineEmojiPopup';
+import { InlineEmojiPopup } from './ui/InlineEmojiPopup';
 export const emojiToTypeaheadItem = (emoji, emojiProvider) => ({
   title: emoji.shortName || '',
   key: emoji.id || emoji.shortName,
@@ -285,16 +285,6 @@ export const emojiPlugin = ({
       if (!api || editorExperiment('platform_editor_controls', 'control') || !editorView) {
         return null;
       }
-      if (!editorExperiment('platform_editor_controls_performance_fixes', true)) {
-        return /*#__PURE__*/React.createElement(InlineEmojiPopupOld, {
-          api: api,
-          editorView: editorView,
-          popupsBoundariesElement: popupsBoundariesElement,
-          popupsMountPoint: popupsMountPoint,
-          popupsScrollableElement: popupsScrollableElement,
-          onClose: () => editorView.dispatch(setInlineEmojiPopupOpen(false)(editorView.state.tr))
-        });
-      }
       return /*#__PURE__*/React.createElement(InlineEmojiPopup, {
         api: api,
         editorView: editorView,

package/dist/es2019/pm-plugins/providers/EmojiNodeDataProvider.js

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { isSSR } from '@atlaskit/editor-common/core-utils';
 import { defaultEmojiHeight } from '@atlaskit/emoji';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 export class EmojiNodeDataProvider extends NodeDataProvider {
@@ -21,10 +22,13 @@ export class EmojiNodeDataProvider extends NodeDataProvider {
     // This is how emojis are server-side rendered in Confluence.
     // Without this, the emoji server response will hit timeout on SSR and the emoji will not be rendered.
     //
+    // We are using this optimization only in SSR because on client side we need to know a valid emoji size
+    // which is not possible to get from optimisticImageApi.
+    //
     // Check platform/packages/editor/renderer/src/react/nodes/emoji.tsx
     // and platform/packages/elements/emoji/src/components/common/ResourcedEmojiComponent.tsx
     const getOptimisticImageUrl = (_this$emojiResource$e = this.emojiResource.emojiProviderConfig.optimisticImageApi) === null || _this$emojiResource$e === void 0 ? void 0 : _this$emojiResource$e.getUrl;
-    if (getOptimisticImageUrl) {
+    if (isSSR() && getOptimisticImageUrl) {
       return nodes.map(node => {
         const emojiId = {
           id: node.attrs.id,
@@ -53,7 +57,7 @@ export class EmojiNodeDataProvider extends NodeDataProvider {
     // This is slower path because during access to emojiProvider emojiResource
     // makes a request to fetch all emojis.
     const emojiProvider = await this.emojiProvider;
-    const fetches = nodes.map(node => {
+    const fetches = nodes.map(async node => {
       const emojiId = {
         id: node.attrs.id,
         shortName: node.attrs.shortName,
@@ -61,7 +65,22 @@ export class EmojiNodeDataProvider extends NodeDataProvider {
       };
 
       // This usually fast because the emojiProvider already has all emojis fetched.
-      return emojiProvider.fetchByEmojiId(emojiId, true);
+      const result = await emojiProvider.fetchByEmojiId(emojiId, true);
+
+      // If we have optimisticImageApi, we need to path response and set URL from it to match the URL used in SSR.
+      if (getOptimisticImageUrl && result) {
+        const optimisticImageURL = getOptimisticImageUrl(emojiId);
+        if (result.representation && 'imagePath' in result.representation) {
+          return {
+            ...result,
+            representation: {
+              ...result.representation,
+              imagePath: optimisticImageURL
+            }
+          };
+        }
+      }
+      return result;
     });
     return Promise.all(fetches);
   }

package/dist/esm/emojiPlugin.js

@@ -22,7 +22,7 @@ import { emojiNodeSpec } from './nodeviews/emojiNodeSpec';
 import { EmojiNodeView } from './nodeviews/EmojiNodeView';
 import { ACTIONS, openTypeAhead as openTypeAheadAction, setAsciiMap as setAsciiMapAction, setInlineEmojiPopupOpen, setProvider as setProviderAction } from './pm-plugins/actions';
 import { inputRulePlugin as asciiInputRulePlugin } from './pm-plugins/ascii-input-rules';
-import { InlineEmojiPopup, InlineEmojiPopupOld } from './ui/InlineEmojiPopup';
+import { InlineEmojiPopup } from './ui/InlineEmojiPopup';
 export var emojiToTypeaheadItem = function emojiToTypeaheadItem(emoji, emojiProvider) {
   return {
     title: emoji.shortName || '',
@@ -307,18 +307,6 @@ export var emojiPlugin = function emojiPlugin(_ref2) {
       if (!api || editorExperiment('platform_editor_controls', 'control') || !editorView) {
         return null;
       }
-      if (!editorExperiment('platform_editor_controls_performance_fixes', true)) {
-        return /*#__PURE__*/React.createElement(InlineEmojiPopupOld, {
-          api: api,
-          editorView: editorView,
-          popupsBoundariesElement: popupsBoundariesElement,
-          popupsMountPoint: popupsMountPoint,
-          popupsScrollableElement: popupsScrollableElement,
-          onClose: function onClose() {
-            return editorView.dispatch(setInlineEmojiPopupOpen(false)(editorView.state.tr));
-          }
-        });
-      }
       return /*#__PURE__*/React.createElement(InlineEmojiPopup, {
         api: api,
         editorView: editorView,

package/dist/esm/pm-plugins/providers/EmojiNodeDataProvider.js

@@ -6,8 +6,11 @@ import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+import { isSSR } from '@atlaskit/editor-common/core-utils';
 import { defaultEmojiHeight } from '@atlaskit/emoji';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 export var EmojiNodeDataProvider = /*#__PURE__*/function (_NodeDataProvider) {
@@ -35,24 +38,27 @@ export var EmojiNodeDataProvider = /*#__PURE__*/function (_NodeDataProvider) {
   }, {
     key: "fetchNodesData",
     value: function () {
-      var _fetchNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(nodes) {
+      var _fetchNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(nodes) {
         var _this$emojiResource$e;
         var getOptimisticImageUrl, emojiProvider, fetches;
-        return _regeneratorRuntime.wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
+        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
             case 0:
               // If we have an `optimisticImageApi`, use it to generate a URL immediately.
               // This is how emojis are server-side rendered in Confluence.
               // Without this, the emoji server response will hit timeout on SSR and the emoji will not be rendered.
               //
+              // We are using this optimization only in SSR because on client side we need to know a valid emoji size
+              // which is not possible to get from optimisticImageApi.
+              //
               // Check platform/packages/editor/renderer/src/react/nodes/emoji.tsx
               // and platform/packages/elements/emoji/src/components/common/ResourcedEmojiComponent.tsx
               getOptimisticImageUrl = (_this$emojiResource$e = this.emojiResource.emojiProviderConfig.optimisticImageApi) === null || _this$emojiResource$e === void 0 ? void 0 : _this$emojiResource$e.getUrl;
-              if (!getOptimisticImageUrl) {
-                _context.next = 3;
+              if (!(isSSR() && getOptimisticImageUrl)) {
+                _context2.next = 3;
                 break;
               }
-              return _context.abrupt("return", nodes.map(function (node) {
+              return _context2.abrupt("return", nodes.map(function (node) {
                 var emojiId = {
                   id: node.attrs.id,
                   shortName: node.attrs.shortName,
@@ -76,26 +82,57 @@ export var EmojiNodeDataProvider = /*#__PURE__*/function (_NodeDataProvider) {
                 };
               }));
             case 3:
-              _context.next = 5;
+              _context2.next = 5;
               return this.emojiProvider;
             case 5:
-              emojiProvider = _context.sent;
-              fetches = nodes.map(function (node) {
-                var emojiId = {
-                  id: node.attrs.id,
-                  shortName: node.attrs.shortName,
-                  fallback: node.attrs.text
+              emojiProvider = _context2.sent;
+              fetches = nodes.map( /*#__PURE__*/function () {
+                var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(node) {
+                  var emojiId, result, optimisticImageURL;
+                  return _regeneratorRuntime.wrap(function _callee$(_context) {
+                    while (1) switch (_context.prev = _context.next) {
+                      case 0:
+                        emojiId = {
+                          id: node.attrs.id,
+                          shortName: node.attrs.shortName,
+                          fallback: node.attrs.text
+                        }; // This usually fast because the emojiProvider already has all emojis fetched.
+                        _context.next = 3;
+                        return emojiProvider.fetchByEmojiId(emojiId, true);
+                      case 3:
+                        result = _context.sent;
+                        if (!(getOptimisticImageUrl && result)) {
+                          _context.next = 8;
+                          break;
+                        }
+                        optimisticImageURL = getOptimisticImageUrl(emojiId);
+                        if (!(result.representation && 'imagePath' in result.representation)) {
+                          _context.next = 8;
+                          break;
+                        }
+                        return _context.abrupt("return", _objectSpread(_objectSpread({}, result), {}, {
+                          representation: _objectSpread(_objectSpread({}, result.representation), {}, {
+                            imagePath: optimisticImageURL
+                          })
+                        }));
+                      case 8:
+                        return _context.abrupt("return", result);
+                      case 9:
+                      case "end":
+                        return _context.stop();
+                    }
+                  }, _callee);
+                }));
+                return function (_x2) {
+                  return _ref.apply(this, arguments);
                 };
-
-                // This usually fast because the emojiProvider already has all emojis fetched.
-                return emojiProvider.fetchByEmojiId(emojiId, true);
-              });
-              return _context.abrupt("return", Promise.all(fetches));
+              }());
+              return _context2.abrupt("return", Promise.all(fetches));
             case 8:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
-        }, _callee, this);
+        }, _callee2, this);
       }));
       function fetchNodesData(_x) {
         return _fetchNodesData.apply(this, arguments);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-emoji",
-	"version": "7.1.1",
+	"version": "7.2.0",
 	"description": "Emoji plugin for @atlaskit/editor-core",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -24,19 +24,19 @@
 		"@atlaskit/adf-schema": "^51.2.0",
 		"@atlaskit/editor-plugin-analytics": "^6.1.0",
 		"@atlaskit/editor-plugin-annotation": "^6.1.0",
-		"@atlaskit/editor-plugin-base": "^7.0.0",
+		"@atlaskit/editor-plugin-base": "^7.1.0",
 		"@atlaskit/editor-plugin-editor-viewmode": "^8.0.0",
 		"@atlaskit/editor-plugin-metrics": "^7.0.0",
-		"@atlaskit/editor-plugin-type-ahead": "^6.1.0",
+		"@atlaskit/editor-plugin-type-ahead": "^6.4.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.6.0",
 		"@atlaskit/emoji": "^69.5.0",
-		"@atlaskit/icon": "^28.3.0",
-		"@atlaskit/node-data-provider": "^7.0.0",
+		"@atlaskit/icon": "^28.5.0",
+		"@atlaskit/node-data-provider": "^7.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/prosemirror-input-rules": "^3.4.0",
+		"@atlaskit/prosemirror-input-rules": "^3.5.0",
 		"@atlaskit/theme": "^21.0.0",
-		"@atlaskit/tmp-editor-statsig": "^13.0.0",
+		"@atlaskit/tmp-editor-statsig": "^13.10.0",
 		"@atlaskit/tokens": "^6.4.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
@@ -45,7 +45,7 @@
 		"react-loadable": "^5.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.4.0",
+		"@atlaskit/editor-common": "^110.10.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},