@atlaskit/editor-plugin-emoji 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-emoji
 
+## 0.2.0
+
+### Minor Changes
+
+- [`113fcc02759`](https://bitbucket.org/atlassian/atlassian-frontend/commits/113fcc02759) - ED-19433 Extract Emoji Plugin to its own package
+
 ## 0.1.2
 
 ### Patch Changes

package/dist/cjs/commands/insert-emoji.js

@@ -0,0 +1,47 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.insertEmoji = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _model = require("@atlaskit/editor-prosemirror/model");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _utils = require("@atlaskit/editor-prosemirror/utils");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var insertEmoji = function insertEmoji(editorAnalyticsAPI) {
+  return function (emojiId, inputMethod) {
+    return function (_ref) {
+      var tr = _ref.tr;
+      var doc = tr.doc,
+        selection = tr.selection;
+      var emoji = tr.doc.type.schema.nodes.emoji;
+      if (emoji && emojiId) {
+        var node = emoji.createChecked(_objectSpread(_objectSpread({}, emojiId), {}, {
+          text: emojiId.fallback || emojiId.shortName
+        }));
+        var textNode = doc.type.schema.text(' ');
+        var fragment = _model.Fragment.fromArray([node, textNode]);
+        var newTr = (0, _utils.safeInsert)(fragment)(tr);
+        if (inputMethod) {
+          editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent({
+            action: _analytics.ACTION.INSERTED,
+            actionSubject: _analytics.ACTION_SUBJECT.DOCUMENT,
+            actionSubjectId: _analytics.ACTION_SUBJECT_ID.EMOJI,
+            attributes: {
+              inputMethod: inputMethod
+            },
+            eventType: _analytics.EVENT_TYPE.TRACK
+          })(newTr);
+        }
+        newTr.setSelection(_state.Selection.near(newTr.doc.resolve(selection.$from.pos + fragment.size)));
+        return newTr;
+      }
+      return null;
+    };
+  };
+};
+exports.insertEmoji = insertEmoji;

package/dist/cjs/index.js

@@ -2,4 +2,11 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+Object.defineProperty(exports, "emojiPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _plugin.emojiPlugin;
+  }
+});
+var _plugin = require("./plugin");

package/dist/cjs/messages.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.messages = void 0;
+var _reactIntlNext = require("react-intl-next");
+var messages = (0, _reactIntlNext.defineMessages)({
+  emojiNodeLabel: {
+    id: 'fabric.emoji.label',
+    defaultMessage: 'Emoji',
+    description: 'Label to indicate emoji node to Screen reader users'
+  }
+});
+exports.messages = messages;

package/dist/cjs/nodeviews/emoji.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EmojiNodeView = EmojiNodeView;
+var _react = _interopRequireDefault(require("react"));
+var _reactIntlNext = require("react-intl-next");
+var _messages = require("../messages");
+var _Emoji = _interopRequireDefault(require("../ui/Emoji"));
+var EmojiAssistiveTextComponent = /*#__PURE__*/_react.default.memo(function (_ref) {
+  var emojiShortName = _ref.emojiShortName;
+  var intl = (0, _reactIntlNext.useIntl)();
+  return /*#__PURE__*/_react.default.createElement("span", {
+    className: 'assistive'
+  }, "".concat(intl.formatMessage(_messages.messages.emojiNodeLabel), " ").concat(emojiShortName));
+});
+function EmojiNodeView(props) {
+  var _props$node$attrs = props.node.attrs,
+    shortName = _props$node$attrs.shortName,
+    id = _props$node$attrs.id,
+    text = _props$node$attrs.text;
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(EmojiAssistiveTextComponent, {
+    emojiShortName: shortName
+  }), /*#__PURE__*/_react.default.createElement("span", {
+    "aria-hidden": "true"
+  }, /*#__PURE__*/_react.default.createElement(_Emoji.default, {
+    providers: props.providerFactory,
+    id: id,
+    shortName: shortName,
+    fallback: text
+  })));
+}

package/dist/cjs/plugin.js

@@ -0,0 +1,409 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ACTIONS = void 0;
+exports.createEmojiPlugin = createEmojiPlugin;
+exports.createRateLimitReachedFunction = createRateLimitReachedFunction;
+exports.emojiToTypeaheadItem = exports.emojiPluginKey = exports.emojiPlugin = exports.defaultListLimit = void 0;
+exports.getEmojiPluginState = getEmojiPluginState;
+exports.memoize = memoize;
+exports.setProvider = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _react = _interopRequireDefault(require("react"));
+var _adfSchema = require("@atlaskit/adf-schema");
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _messages = require("@atlaskit/editor-common/messages");
+var _quickInsert = require("@atlaskit/editor-common/quick-insert");
+var _reactNodeView = require("@atlaskit/editor-common/react-node-view");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _typeAhead = require("@atlaskit/editor-common/type-ahead");
+var _model = require("@atlaskit/editor-prosemirror/model");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _emoji2 = require("@atlaskit/emoji");
+var _insertEmoji = require("./commands/insert-emoji");
+var _emoji3 = require("./nodeviews/emoji");
+var _asciiInputRules = require("./pm-plugins/ascii-input-rules");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var emojiToTypeaheadItem = function emojiToTypeaheadItem(emoji, emojiProvider) {
+  return {
+    title: emoji.shortName || '',
+    key: emoji.id || emoji.shortName,
+    render: function render(_ref) {
+      var isSelected = _ref.isSelected,
+        onClick = _ref.onClick,
+        onHover = _ref.onHover;
+      return /*#__PURE__*/_react.default.createElement(_emoji2.EmojiTypeAheadItem, {
+        emoji: emoji,
+        selected: isSelected,
+        onMouseMove: onHover,
+        onSelection: onClick,
+        emojiProvider: emojiProvider
+      });
+    },
+    emoji: emoji
+  };
+};
+exports.emojiToTypeaheadItem = emojiToTypeaheadItem;
+function memoize(fn) {
+  // Cache results here
+  var seen = new Map();
+  function memoized(emoji, emojiProvider) {
+    // Check cache for hits
+    var hit = seen.get(emoji.id || emoji.shortName);
+    if (hit) {
+      return hit;
+    }
+
+    // Generate new result and cache it
+    var result = fn(emoji, emojiProvider);
+    seen.set(emoji.id || emoji.shortName, result);
+    return result;
+  }
+  return {
+    call: memoized,
+    clear: seen.clear.bind(seen)
+  };
+}
+var memoizedToItem = memoize(emojiToTypeaheadItem);
+var defaultListLimit = 50;
+exports.defaultListLimit = defaultListLimit;
+var isFullShortName = function isFullShortName(query) {
+  return query && query.length > 1 && query.charAt(0) === ':' && query.charAt(query.length - 1) === ':';
+};
+var TRIGGER = ':';
+var emojiPlugin = function emojiPlugin(_ref2) {
+  var _api$analytics5;
+  var options = _ref2.config,
+    api = _ref2.api;
+  var typeAhead = {
+    id: _typeAhead.TypeAheadAvailableNodes.EMOJI,
+    trigger: TRIGGER,
+    // Custom regex must have a capture group around trigger
+    // so it's possible to use it without needing to scan through all triggers again
+    customRegex: '\\(?(:)',
+    headless: options ? options.headless : undefined,
+    getItems: function getItems(_ref3) {
+      var query = _ref3.query,
+        editorState = _ref3.editorState;
+      var pluginState = getEmojiPluginState(editorState);
+      var emojiProvider = pluginState.emojiProvider;
+      if (!emojiProvider) {
+        return Promise.resolve([]);
+      }
+      return new Promise(function (resolve) {
+        var emojiProviderChangeHandler = {
+          result: function result(emojiResult) {
+            if (!emojiResult || !emojiResult.emojis) {
+              resolve([]);
+            } else {
+              var emojiItems = emojiResult.emojis.map(function (emoji) {
+                return memoizedToItem.call(emoji, emojiProvider);
+              });
+              resolve(emojiItems);
+            }
+            emojiProvider.unsubscribe(emojiProviderChangeHandler);
+          }
+        };
+        emojiProvider.subscribe(emojiProviderChangeHandler);
+        emojiProvider.filter(TRIGGER.concat(query), {
+          limit: defaultListLimit,
+          skinTone: emojiProvider.getSelectedTone(),
+          sort: !query.length ? _emoji2.SearchSort.UsageFrequency : _emoji2.SearchSort.Default
+        });
+      });
+    },
+    forceSelect: function forceSelect(_ref4) {
+      var query = _ref4.query,
+        items = _ref4.items,
+        editorState = _ref4.editorState;
+      var _ref5 = emojiPluginKey.getState(editorState) || {},
+        asciiMap = _ref5.asciiMap;
+      var normalizedQuery = TRIGGER.concat(query);
+
+      // if the query has space at the end
+      // check the ascii map for emojis
+      if (asciiMap && normalizedQuery.length >= 3 && normalizedQuery.endsWith(' ') && asciiMap.has(normalizedQuery.trim())) {
+        var _emoji = asciiMap.get(normalizedQuery.trim());
+        return {
+          title: (_emoji === null || _emoji === void 0 ? void 0 : _emoji.name) || '',
+          emoji: _emoji
+        };
+      }
+      var matchedItem = isFullShortName(normalizedQuery) ? items.find(function (item) {
+        return item.title.toLowerCase() === normalizedQuery;
+      }) : undefined;
+      return matchedItem;
+    },
+    selectItem: function selectItem(state, item, insert, _ref6) {
+      var _api$analytics3;
+      var mode = _ref6.mode;
+      var _item$emoji = item.emoji,
+        _item$emoji$id = _item$emoji.id,
+        id = _item$emoji$id === void 0 ? '' : _item$emoji$id,
+        fallback = _item$emoji.fallback,
+        shortName = _item$emoji.shortName;
+      var text = fallback || shortName;
+      var emojiPluginState = emojiPluginKey.getState(state);
+      if (emojiPluginState.emojiProvider && emojiPluginState.emojiProvider.recordSelection && item.emoji) {
+        var _api$analytics$shared, _api$analytics, _api$analytics$shared2, _api$analytics$shared3, _api$analytics2, _api$analytics2$share;
+        emojiPluginState.emojiProvider.recordSelection(item.emoji).then((0, _emoji2.recordSelectionSucceededSli)({
+          createAnalyticsEvent: (_api$analytics$shared = api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : (_api$analytics$shared2 = _api$analytics.sharedState.currentState()) === null || _api$analytics$shared2 === void 0 ? void 0 : _api$analytics$shared2.createAnalyticsEvent) !== null && _api$analytics$shared !== void 0 ? _api$analytics$shared : undefined
+        })).catch((0, _emoji2.recordSelectionFailedSli)({
+          createAnalyticsEvent: (_api$analytics$shared3 = api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : (_api$analytics2$share = _api$analytics2.sharedState.currentState()) === null || _api$analytics2$share === void 0 ? void 0 : _api$analytics2$share.createAnalyticsEvent) !== null && _api$analytics$shared3 !== void 0 ? _api$analytics$shared3 : undefined
+        }));
+      }
+      var emojiNode = state.schema.nodes.emoji.createChecked({
+        shortName: shortName,
+        id: id,
+        text: text
+      });
+      var space = state.schema.text(' ');
+      var tr = insert(_model.Fragment.from([emojiNode, space]));
+      api === null || api === void 0 ? void 0 : (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions.attachAnalyticsEvent({
+        action: _analytics.ACTION.INSERTED,
+        actionSubject: _analytics.ACTION_SUBJECT.DOCUMENT,
+        actionSubjectId: _analytics.ACTION_SUBJECT_ID.EMOJI,
+        attributes: {
+          inputMethod: _analytics.INPUT_METHOD.TYPEAHEAD
+        },
+        eventType: _analytics.EVENT_TYPE.TRACK
+      })(tr);
+      return tr;
+    }
+  };
+  return {
+    name: 'emoji',
+    nodes: function nodes() {
+      return [{
+        name: 'emoji',
+        node: _adfSchema.emoji
+      }];
+    },
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'emoji',
+        plugin: function plugin(pmPluginFactoryParams) {
+          return createEmojiPlugin(pmPluginFactoryParams);
+        }
+      }, {
+        name: 'emojiAsciiInputRule',
+        plugin: function plugin(_ref7) {
+          var _api$analytics4;
+          var schema = _ref7.schema,
+            providerFactory = _ref7.providerFactory,
+            featureFlags = _ref7.featureFlags;
+          return (0, _asciiInputRules.inputRulePlugin)(schema, providerFactory, featureFlags, api === null || api === void 0 ? void 0 : (_api$analytics4 = api.analytics) === null || _api$analytics4 === void 0 ? void 0 : _api$analytics4.actions);
+        }
+      }];
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return undefined;
+      }
+      return emojiPluginKey.getState(editorState);
+    },
+    commands: {
+      insertEmoji: (0, _insertEmoji.insertEmoji)(api === null || api === void 0 ? void 0 : (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions)
+    },
+    pluginsOptions: {
+      quickInsert: function quickInsert(_ref8) {
+        var formatMessage = _ref8.formatMessage;
+        return [{
+          id: 'emoji',
+          title: formatMessage(_messages.toolbarInsertBlockMessages.emoji),
+          description: formatMessage(_messages.toolbarInsertBlockMessages.emojiDescription),
+          priority: 500,
+          keyshortcut: ':',
+          icon: function icon() {
+            return /*#__PURE__*/_react.default.createElement(_quickInsert.IconEmoji, null);
+          },
+          action: function action(insert, state) {
+            var _api$analytics6;
+            var tr = insert(undefined);
+            api === null || api === void 0 ? void 0 : api.typeAhead.commands.openTypeAheadAtCursor({
+              triggerHandler: typeAhead,
+              inputMethod: _analytics.INPUT_METHOD.QUICK_INSERT
+            })({
+              tr: tr
+            });
+            api === null || api === void 0 ? void 0 : (_api$analytics6 = api.analytics) === null || _api$analytics6 === void 0 ? void 0 : _api$analytics6.actions.attachAnalyticsEvent({
+              action: _analytics.ACTION.INVOKED,
+              actionSubject: _analytics.ACTION_SUBJECT.TYPEAHEAD,
+              actionSubjectId: _analytics.ACTION_SUBJECT_ID.TYPEAHEAD_EMOJI,
+              attributes: {
+                inputMethod: _analytics.INPUT_METHOD.QUICK_INSERT
+              },
+              eventType: _analytics.EVENT_TYPE.UI
+            })(tr);
+            return tr;
+          }
+        }];
+      },
+      typeAhead: typeAhead
+    }
+  };
+};
+
+/**
+ * Actions
+ */
+exports.emojiPlugin = emojiPlugin;
+var ACTIONS = {
+  SET_PROVIDER: 'SET_PROVIDER',
+  SET_RESULTS: 'SET_RESULTS',
+  SET_ASCII_MAP: 'SET_ASCII_MAP'
+};
+exports.ACTIONS = ACTIONS;
+var setAsciiMap = function setAsciiMap(asciiMap) {
+  return function (state, dispatch) {
+    if (dispatch) {
+      dispatch(state.tr.setMeta(emojiPluginKey, {
+        action: ACTIONS.SET_ASCII_MAP,
+        params: {
+          asciiMap: asciiMap
+        }
+      }));
+    }
+    return true;
+  };
+};
+
+/**
+ *
+ * Wrapper to call `onLimitReached` when a specified number of calls of that function
+ * have been made within a time period.
+ *
+ * Note: It does not rate limit
+ *
+ * @param fn Function to wrap
+ * @param limitTime Time limit in milliseconds
+ * @param limitCount Number of function calls before `onRateReached` is called (per time period)
+ * @returns Wrapped function
+ */
+function createRateLimitReachedFunction(fn, limitTime, limitCount, onLimitReached) {
+  var lastCallTime = 0;
+  var callCount = 0;
+  return function wrappedFn() {
+    var now = Date.now();
+    if (now - lastCallTime < limitTime) {
+      if (++callCount > limitCount) {
+        onLimitReached === null || onLimitReached === void 0 ? void 0 : onLimitReached();
+      }
+    } else {
+      lastCallTime = now;
+      callCount = 1;
+    }
+    return fn.apply(void 0, arguments);
+  };
+}
+
+// At this stage console.error only
+var logRateWarning = function logRateWarning() {
+  if (process.env.NODE_ENV === 'development') {
+    // eslint-disable-next-line no-console
+    console.error('The emoji provider injected in the Editor is being reloaded frequently, this will cause a slow Editor experience.');
+  }
+};
+var setProvider = createRateLimitReachedFunction(function (provider) {
+  return function (state, dispatch) {
+    if (dispatch) {
+      dispatch(state.tr.setMeta(emojiPluginKey, {
+        action: ACTIONS.SET_PROVIDER,
+        params: {
+          provider: provider
+        }
+      }));
+    }
+    return true;
+  };
+},
+// If we change the emoji provider more than three times every 5 seconds we should warn.
+// This seems like a really long time but the performance can be that laggy that we don't
+// even get 3 events in 3 seconds and miss this indicator.
+5000, 3, logRateWarning);
+exports.setProvider = setProvider;
+var emojiPluginKey = new _state.PluginKey('emojiPlugin');
+exports.emojiPluginKey = emojiPluginKey;
+function getEmojiPluginState(state) {
+  return emojiPluginKey.getState(state) || {};
+}
+function createEmojiPlugin(pmPluginFactoryParams) {
+  return new _safePlugin.SafePlugin({
+    key: emojiPluginKey,
+    state: {
+      init: function init() {
+        return {};
+      },
+      apply: function apply(tr, pluginState) {
+        var _ref9 = tr.getMeta(emojiPluginKey) || {
+            action: null,
+            params: null
+          },
+          action = _ref9.action,
+          params = _ref9.params;
+        var newPluginState = pluginState;
+        switch (action) {
+          case ACTIONS.SET_PROVIDER:
+            newPluginState = _objectSpread(_objectSpread({}, pluginState), {}, {
+              emojiProvider: params.provider
+            });
+            pmPluginFactoryParams.dispatch(emojiPluginKey, newPluginState);
+            return newPluginState;
+          case ACTIONS.SET_ASCII_MAP:
+            newPluginState = _objectSpread(_objectSpread({}, pluginState), {}, {
+              asciiMap: params.asciiMap
+            });
+            pmPluginFactoryParams.dispatch(emojiPluginKey, newPluginState);
+            return newPluginState;
+        }
+        return newPluginState;
+      }
+    },
+    props: {
+      nodeViews: {
+        emoji: (0, _reactNodeView.getInlineNodeViewProducer)({
+          pmPluginFactoryParams: pmPluginFactoryParams,
+          Component: _emoji3.EmojiNodeView,
+          extraComponentProps: {
+            providerFactory: pmPluginFactoryParams.providerFactory
+          }
+        })
+      }
+    },
+    view: function view(editorView) {
+      var providerHandler = function providerHandler(name, providerPromise) {
+        switch (name) {
+          case 'emojiProvider':
+            if (!providerPromise) {
+              var _setProvider;
+              return setProvider === null || setProvider === void 0 ? void 0 : (_setProvider = setProvider(undefined)) === null || _setProvider === void 0 ? void 0 : _setProvider(editorView.state, editorView.dispatch);
+            }
+            providerPromise.then(function (provider) {
+              var _setProvider2;
+              setProvider === null || setProvider === void 0 ? void 0 : (_setProvider2 = setProvider(provider)) === null || _setProvider2 === void 0 ? void 0 : _setProvider2(editorView.state, editorView.dispatch);
+              provider.getAsciiMap().then(function (asciiMap) {
+                setAsciiMap(asciiMap)(editorView.state, editorView.dispatch);
+              });
+            }).catch(function () {
+              var _setProvider3;
+              return setProvider === null || setProvider === void 0 ? void 0 : (_setProvider3 = setProvider(undefined)) === null || _setProvider3 === void 0 ? void 0 : _setProvider3(editorView.state, editorView.dispatch);
+            });
+            break;
+        }
+        return;
+      };
+      pmPluginFactoryParams.providerFactory.subscribe('emojiProvider', providerHandler);
+      return {
+        destroy: function destroy() {
+          if (pmPluginFactoryParams.providerFactory) {
+            pmPluginFactoryParams.providerFactory.unsubscribe('emojiProvider', providerHandler);
+          }
+        }
+      };
+    }
+  });
+}