@atlaskit/emoji 71.17.0 → 72.0.0

package/dist/esm/util/analytics/withSampling.js

@@ -0,0 +1,175 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+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; }
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { isExperienceSampled } from './isExperienceSampled';
+import { ufoExperiencesSampled } from './samplingUfo';
+var hasSampledFromStart = function hasSampledFromStart(experience) {
+  if (!ufoExperiencesSampled[experience.id]) {
+    return false;
+  }
+  if (experience.instanceId) {
+    // if the instance of concurrent exp has been sampled from start, allow it.
+    return ufoExperiencesSampled[experience.id].sampledInstance[experience.instanceId];
+  }
+  return ufoExperiencesSampled[experience.id].sampled;
+};
+
+/**
+ * This function is a temp solution to reduce the event traffic, as UFO package does not support it.
+ *
+ * e.g. Emoji Picker contains thousands of emojis, which means will trigger a large number of renderred events without sampling
+ * @param ufoExperience
+ * @returns
+ */
+export var withSampling = function withSampling(ufoExperience) {
+  var init = function init() {
+    if (!ufoExperiencesSampled[ufoExperience.id]) {
+      ufoExperiencesSampled[ufoExperience.id] = {
+        sampled: false,
+        sampledInstance: {}
+      };
+    }
+  };
+  var start = /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(options) {
+      var isSampled;
+      return _regeneratorRuntime.wrap(function (_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            if (!hasSampledFromStart(ufoExperience)) {
+              _context.next = 1;
+              break;
+            }
+            return _context.abrupt("return");
+          case 1:
+            isSampled = options.samplingFunc || isExperienceSampled;
+            if (isSampled(options.samplingRate)) {
+              _context.next = 2;
+              break;
+            }
+            if (ufoExperience.instanceId) {
+              ufoExperiencesSampled[ufoExperience.id].sampledInstance[ufoExperience.instanceId] = false;
+            }
+            ufoExperiencesSampled[ufoExperience.id].sampled = false;
+            return _context.abrupt("return");
+          case 2:
+            // update sampled records
+            if (ufoExperience.instanceId) {
+              ufoExperiencesSampled[ufoExperience.id].sampledInstance[ufoExperience.instanceId] = true;
+              ufoExperiencesSampled[ufoExperience.id].sampled = true;
+            }
+            return _context.abrupt("return", ufoExperience.start(options.startTime));
+          case 3:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee);
+    }));
+    return function start(_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+  var success = /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(config) {
+      return _regeneratorRuntime.wrap(function (_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
+          case 0:
+            if (hasSampledFromStart(ufoExperience)) {
+              _context2.next = 1;
+              break;
+            }
+            return _context2.abrupt("return", null);
+          case 1:
+            return _context2.abrupt("return", ufoExperience.success(config));
+          case 2:
+          case "end":
+            return _context2.stop();
+        }
+      }, _callee2);
+    }));
+    return function success(_x2) {
+      return _ref2.apply(this, arguments);
+    };
+  }();
+  var failure = /*#__PURE__*/function () {
+    var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(config) {
+      return _regeneratorRuntime.wrap(function (_context3) {
+        while (1) switch (_context3.prev = _context3.next) {
+          case 0:
+            if (hasSampledFromStart(ufoExperience)) {
+              _context3.next = 1;
+              break;
+            }
+            return _context3.abrupt("return", null);
+          case 1:
+            return _context3.abrupt("return", ufoExperience.failure(config));
+          case 2:
+          case "end":
+            return _context3.stop();
+        }
+      }, _callee3);
+    }));
+    return function failure(_x3) {
+      return _ref3.apply(this, arguments);
+    };
+  }();
+  var abort = /*#__PURE__*/function () {
+    var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(config) {
+      return _regeneratorRuntime.wrap(function (_context4) {
+        while (1) switch (_context4.prev = _context4.next) {
+          case 0:
+            if (hasSampledFromStart(ufoExperience)) {
+              _context4.next = 1;
+              break;
+            }
+            return _context4.abrupt("return", null);
+          case 1:
+            return _context4.abrupt("return", ufoExperience.abort(config));
+          case 2:
+          case "end":
+            return _context4.stop();
+        }
+      }, _callee4);
+    }));
+    return function abort(_x4) {
+      return _ref4.apply(this, arguments);
+    };
+  }();
+  var addMetadata = function addMetadata(data) {
+    if (!hasSampledFromStart(ufoExperience)) {
+      return;
+    }
+    return ufoExperience.addMetadata(data);
+  };
+  var mark = function mark(name, timestamp) {
+    if (!hasSampledFromStart(ufoExperience)) {
+      return;
+    }
+    return ufoExperience.mark(name, timestamp);
+  };
+  var markFMP = function markFMP(timestamp) {
+    if (!hasSampledFromStart(ufoExperience)) {
+      return;
+    }
+    return ufoExperience.markFMP(timestamp);
+  };
+  var markInlineResponse = function markInlineResponse(timestamp) {
+    if (!hasSampledFromStart(ufoExperience)) {
+      return;
+    }
+    return ufoExperience.markInlineResponse(timestamp);
+  };
+  init();
+  return _objectSpread(_objectSpread({}, ufoExperience), {}, {
+    start: start,
+    addMetadata: addMetadata,
+    success: success,
+    failure: failure,
+    abort: abort,
+    mark: mark,
+    markFMP: markFMP,
+    markInlineResponse: markInlineResponse
+  });
+};

package/dist/esm/util/build-emoji-description-with-alt-representation.js

@@ -0,0 +1,12 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
+// Prevent altRepresentation: undefined from being returned in EmojiDescription
+export var buildEmojiDescriptionWithAltRepresentation = function buildEmojiDescriptionWithAltRepresentation(emoji, altRepresentation) {
+  if (!altRepresentation) {
+    return emoji;
+  }
+  return _objectSpread(_objectSpread({}, emoji), {}, {
+    altRepresentation: altRepresentation
+  });
+};

package/dist/esm/util/contains-emoji-id.js

@@ -0,0 +1,12 @@
+import { isEmojiIdEqual } from './is-emoji-id-equal';
+export var containsEmojiId = function containsEmojiId(emojis, emojiId) {
+  if (!emojiId) {
+    return false;
+  }
+  for (var i = 0; i < emojis.length; i++) {
+    if (isEmojiIdEqual(emojis[i], emojiId)) {
+      return true;
+    }
+  }
+  return false;
+};

package/dist/esm/util/convert-image-to-media-representation.js

@@ -0,0 +1,7 @@
+export var convertImageToMediaRepresentation = function convertImageToMediaRepresentation(rep) {
+  return {
+    mediaPath: rep.imagePath,
+    height: rep.height,
+    width: rep.width
+  };
+};

package/dist/esm/util/convert-media-to-image-emoji.js

@@ -0,0 +1,21 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
+import { buildEmojiDescriptionWithAltRepresentation } from './build-emoji-description-with-alt-representation';
+import { convertMediaToImageRepresentation } from './convert-media-to-image-representation';
+import { isMediaRepresentation } from './is-media-representation';
+export var convertMediaToImageEmoji = function convertMediaToImageEmoji(emoji, newImagePath, useAlt) {
+  var mediaRepresentation = emoji.representation;
+  var mediaAltRepresentation = emoji.altRepresentation;
+  var imgPath = !useAlt ? newImagePath : undefined;
+  var altImgPath = useAlt ? newImagePath : undefined;
+  if (!isMediaRepresentation(mediaRepresentation) && !isMediaRepresentation(mediaAltRepresentation)) {
+    return emoji;
+  }
+  var representation = isMediaRepresentation(mediaRepresentation) ? convertMediaToImageRepresentation(mediaRepresentation, imgPath) : mediaRepresentation;
+  var altRepresentation = isMediaRepresentation(mediaAltRepresentation) ? convertMediaToImageRepresentation(mediaAltRepresentation, altImgPath) : mediaAltRepresentation;
+  var baseEmoji = _objectSpread(_objectSpread({}, emoji), {}, {
+    representation: representation
+  });
+  return buildEmojiDescriptionWithAltRepresentation(baseEmoji, altRepresentation);
+};

package/dist/esm/util/convert-media-to-image-representation.js

@@ -0,0 +1,7 @@
+export var convertMediaToImageRepresentation = function convertMediaToImageRepresentation(rep, newImagePath) {
+  return {
+    imagePath: newImagePath || rep.mediaPath,
+    height: rep.height,
+    width: rep.width
+  };
+};

package/dist/esm/util/filter-hidden-emojis.js

@@ -0,0 +1,6 @@
+import { isHiddenEmoji } from './is-hidden-emoji';
+export var filterHiddenEmojis = function filterHiddenEmojis(emojis) {
+  return emojis.filter(function (emoji) {
+    return !isHiddenEmoji(emoji);
+  });
+};

package/dist/esm/util/filters.js

@@ -1,4 +1,4 @@
-var toneEmojiShortName = ':raised_hand:';
+export var toneEmojiShortName = ':raised_hand:';
 var byShortName = function byShortName(emojis, shortName) {
   return emojis.filter(function (emoji) {
     return emoji.shortName === shortName;
@@ -7,9 +7,6 @@ var byShortName = function byShortName(emojis, shortName) {
 var toneEmoji = function toneEmoji(emojis) {
   return byShortName(emojis, toneEmojiShortName);
 };
-export var getToneEmoji = function getToneEmoji(provider) {
-  return provider.findByShortName(toneEmojiShortName);
-};
 var _default_1 = {
   byShortName: byShortName,
   toneEmoji: toneEmoji

package/dist/esm/util/format-shortcut.js

@@ -0,0 +1,23 @@
+/**
+ * Copied from editor-common: https://bitbucket.org/atlassian/atlassian-frontend/src/d01430a20500d720791d0667fd7cfe25d254f2e3/packages/editor/editor-common/src/keymaps/index.tsx
+ */
+
+import browserSupport from './browser-support';
+import { arrowKeysMap } from './keymaps';
+export function formatShortcut(keymap) {
+  var shortcut;
+  if (browserSupport.mac) {
+    // for reference: https://wincent.com/wiki/Unicode_representations_of_modifier_keys
+    shortcut = keymap.mac.replace(/Cmd/i, "\u2318").replace(/Shift/i, "\u21E7").replace(/Ctrl/i, "\u2303").replace(/Alt/i, "\u2325").replace(/Backspace/i, "\u232B").replace(/Enter/i, "\u23CE");
+  } else {
+    shortcut = keymap.windows.replace(/Backspace/i, "\u232B");
+  }
+  var keys = shortcut.split('-');
+  var lastKey = keys[keys.length - 1];
+  if (lastKey.length === 1) {
+    // capitalise single letters
+    lastKey = lastKey.toUpperCase();
+  }
+  keys[keys.length - 1] = arrowKeysMap[lastKey.toUpperCase()] || lastKey;
+  return keys.join(browserSupport.mac ? '' : '+');
+}

package/dist/esm/util/get-category-id.js

@@ -0,0 +1,3 @@
+export var getCategoryId = function getCategoryId(emoji) {
+  return emoji.category;
+};

package/dist/esm/util/get-tone-emoji.js

@@ -0,0 +1,4 @@
+import { toneEmojiShortName } from './filters';
+export var getToneEmoji = function getToneEmoji(provider) {
+  return provider.findByShortName(toneEmojiShortName);
+};

package/dist/esm/util/has-data-url-image.js

@@ -0,0 +1,5 @@
+import { dataURLPrefix } from './constants';
+import { isImageRepresentation } from './is-image-representation';
+export var hasDataURLImage = function hasDataURLImage(rep) {
+  return isImageRepresentation(rep) && rep.imagePath.indexOf(dataURLPrefix) === 0;
+};

package/dist/esm/util/is-emoji-description-with-variations.js

@@ -0,0 +1,3 @@
+export var isEmojiDescriptionWithVariations = function isEmojiDescriptionWithVariations(emoji) {
+  return !!(emoji && emoji.skinVariations);
+};

package/dist/esm/util/is-emoji-description.js

@@ -0,0 +1,3 @@
+export var isEmojiDescription = function isEmojiDescription(possibleEmojiDescription) {
+  return possibleEmojiDescription && possibleEmojiDescription.shortName && possibleEmojiDescription.type;
+};

package/dist/esm/util/is-emoji-id-equal.js

@@ -0,0 +1,3 @@
+export var isEmojiIdEqual = function isEmojiIdEqual(l, r) {
+  return l === r || l && r && l.id === r.id && l.shortName === r.shortName;
+};

package/dist/esm/util/is-emoji-variation-description.js

@@ -0,0 +1,3 @@
+export var isEmojiVariationDescription = function isEmojiVariationDescription(object) {
+  return 'baseId' in object;
+};

package/dist/esm/util/{hidden-emojis.js → is-hidden-emoji.js}

@@ -19,9 +19,4 @@ export var isHiddenEmoji = function isHiddenEmoji(emoji) {
     return true;
   }
   return hasHiddenMetadataTag(emoji);
-};
-export var filterHiddenEmojis = function filterHiddenEmojis(emojis) {
-  return emojis.filter(function (emoji) {
-    return !isHiddenEmoji(emoji);
-  });
 };

package/dist/esm/util/is-image-representation.js

@@ -0,0 +1,3 @@
+export var isImageRepresentation = function isImageRepresentation(rep) {
+  return !!(rep && rep.imagePath);
+};

package/dist/esm/util/is-loaded-media-emoji.js

@@ -0,0 +1,5 @@
+import { customCategory } from './constants';
+import { hasDataURLImage } from './has-data-url-image';
+export var isLoadedMediaEmoji = function isLoadedMediaEmoji(emoji) {
+  return emoji.category === customCategory && hasDataURLImage(emoji.representation);
+};

package/dist/esm/util/is-media-emoji.js

@@ -0,0 +1,4 @@
+import { isMediaRepresentation } from './is-media-representation';
+export var isMediaEmoji = function isMediaEmoji(emoji) {
+  return isMediaRepresentation(emoji.representation);
+};

package/dist/esm/util/is-media-representation.js

@@ -0,0 +1,3 @@
+export var isMediaRepresentation = function isMediaRepresentation(rep) {
+  return !!(rep && rep.mediaPath);
+};

package/dist/esm/util/is-messages-key.js

@@ -0,0 +1,4 @@
+import { messages } from '../components/i18n';
+export var isMessagesKey = function isMessagesKey(key) {
+  return key in messages;
+};

package/dist/esm/util/is-promise.js

@@ -0,0 +1,3 @@
+export var isPromise = function isPromise(p) {
+  return !!(p && p.then);
+};

package/dist/esm/util/is-sprite-representation.js

@@ -0,0 +1,3 @@
+export var isSpriteRepresentation = function isSpriteRepresentation(rep) {
+  return !!(rep && rep.sprite);
+};

package/dist/esm/util/is-sprite-service-representation.js

@@ -0,0 +1,3 @@
+export var isSpriteServiceRepresentation = function isSpriteServiceRepresentation(rep) {
+  return !!(rep && rep.spriteRef);
+};

package/dist/esm/util/is-unicode-representation.js

@@ -0,0 +1,3 @@
+export var isUnicodeRepresentation = function isUnicodeRepresentation(rep) {
+  return !!(rep && rep.unicodeEmoji);
+};

package/dist/esm/util/keymaps.js

@@ -2,42 +2,12 @@
  * Copied from editor-common: https://bitbucket.org/atlassian/atlassian-frontend/src/d01430a20500d720791d0667fd7cfe25d254f2e3/packages/editor/editor-common/src/keymaps/index.tsx
  */
 
-import browserSupport from './browser-support';
+import { makeKeyMapWithCommon } from './make-key-map-with-common';
 export var backspace = makeKeyMapWithCommon('Backspace', 'Backspace');
-export function makeKeymap(description, windows, mac, common) {
-  return {
-    description: description,
-    windows: windows.replace(/Mod/i, 'Ctrl'),
-    mac: mac.replace(/Mod/i, 'Cmd'),
-    common: common
-  };
-}
-export function makeKeyMapWithCommon(description, common) {
-  var windows = common.replace(/Mod/i, 'Ctrl');
-  var mac = common.replace(/Mod/i, 'Cmd');
-  return makeKeymap(description, windows, mac, common);
-}
 export var arrowKeysMap = {
   // for reference: https://wincent.com/wiki/Unicode_representations_of_modifier_keys
   ARROWLEFT: "\u2190",
   ARROWRIGHT: "\u2192",
   ARROWUP: "\u2191",
   ARROWDOWN: "\u2193"
-};
-export function formatShortcut(keymap) {
-  var shortcut;
-  if (browserSupport.mac) {
-    // for reference: https://wincent.com/wiki/Unicode_representations_of_modifier_keys
-    shortcut = keymap.mac.replace(/Cmd/i, "\u2318").replace(/Shift/i, "\u21E7").replace(/Ctrl/i, "\u2303").replace(/Alt/i, "\u2325").replace(/Backspace/i, "\u232B").replace(/Enter/i, "\u23CE");
-  } else {
-    shortcut = keymap.windows.replace(/Backspace/i, "\u232B");
-  }
-  var keys = shortcut.split('-');
-  var lastKey = keys[keys.length - 1];
-  if (lastKey.length === 1) {
-    // capitalise single letters
-    lastKey = lastKey.toUpperCase();
-  }
-  keys[keys.length - 1] = arrowKeysMap[lastKey.toUpperCase()] || lastKey;
-  return keys.join(browserSupport.mac ? '' : '+');
-}
+};

package/dist/esm/util/left-click.js

@@ -0,0 +1,3 @@
+export function leftClick(reactEvent) {
+  return reactEvent.button === 0 && !reactEvent.altKey && !reactEvent.ctrlKey && !reactEvent.metaKey && !reactEvent.shiftKey;
+}

package/dist/esm/util/make-key-map-with-common.js

@@ -0,0 +1,10 @@
+/**
+ * Copied from editor-common: https://bitbucket.org/atlassian/atlassian-frontend/src/d01430a20500d720791d0667fd7cfe25d254f2e3/packages/editor/editor-common/src/keymaps/index.tsx
+ */
+
+import { makeKeymap } from './make-keymap';
+export function makeKeyMapWithCommon(description, common) {
+  var windows = common.replace(/Mod/i, 'Ctrl');
+  var mac = common.replace(/Mod/i, 'Cmd');
+  return makeKeymap(description, windows, mac, common);
+}

package/dist/esm/util/make-keymap.js

@@ -0,0 +1,12 @@
+/**
+ * Copied from editor-common: https://bitbucket.org/atlassian/atlassian-frontend/src/d01430a20500d720791d0667fd7cfe25d254f2e3/packages/editor/editor-common/src/keymaps/index.tsx
+ */
+
+export function makeKeymap(description, windows, mac, common) {
+  return {
+    description: description,
+    windows: windows.replace(/Mod/i, 'Ctrl'),
+    mac: mac.replace(/Mod/i, 'Cmd'),
+    common: common
+  };
+}

package/dist/esm/util/mouse-location.js

@@ -0,0 +1,6 @@
+export function mouseLocation(event) {
+  return {
+    x: event.clientX,
+    y: event.clientY
+  };
+}

package/dist/esm/util/mouse.js

@@ -1,18 +0,0 @@
-export function mouseLocation(event) {
-  return {
-    x: event.clientX,
-    y: event.clientY
-  };
-}
-
-// Used to prevent invalid mouse move detection on scroll
-// lastPosition is object (x, y)
-export function actualMouseMove(oldPosition, newPosition) {
-  if (!oldPosition || oldPosition.x !== newPosition.x || oldPosition.y !== newPosition.y) {
-    return true;
-  }
-  return false;
-}
-export function leftClick(reactEvent) {
-  return reactEvent.button === 0 && !reactEvent.altKey && !reactEvent.ctrlKey && !reactEvent.metaKey && !reactEvent.shiftKey;
-}

package/dist/esm/util/to-emoji-id.js

@@ -0,0 +1,7 @@
+export var toEmojiId = function toEmojiId(emoji) {
+  return {
+    shortName: emoji.shortName,
+    id: emoji.id,
+    fallback: emoji.fallback
+  };
+};

package/dist/esm/util/to-optional-emoji-id.js

@@ -0,0 +1,7 @@
+import { toEmojiId } from './to-emoji-id';
+export var toOptionalEmojiId = function toOptionalEmojiId(emoji) {
+  if (!emoji) {
+    return undefined;
+  }
+  return toEmojiId(emoji);
+};