@atlaskit/emoji 67.0.4 → 67.0.5

package/dist/esm/api/EmojiUtils.js

@@ -1,38 +1,30 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 var _excluded = ["getRatio"],
-    _excluded2 = ["queryParams"],
-    _excluded3 = ["representation", "altRepresentations"],
-    _excluded4 = ["representation", "skinVariations", "altRepresentations"];
-
+  _excluded2 = ["queryParams"],
+  _excluded3 = ["representation", "altRepresentations"],
+  _excluded4 = ["representation", "skinVariations", "altRepresentations"];
 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) { _defineProperty(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; }
-
 import { utils as serviceUtils } from '@atlaskit/util-service-support';
 import { isImageRepresentation, isSpriteServiceRepresentation, convertImageToMediaRepresentation, buildEmojiDescriptionWithAltRepresentation } from '../util/type-helpers';
 import debug from '../util/logger';
 export var emojiRequest = function emojiRequest(provider, options) {
   var _provider$getRatio = provider.getRatio,
-      getRatio = _provider$getRatio === void 0 ? getPixelRatio : _provider$getRatio,
-      serviceConfig = _objectWithoutProperties(provider, _excluded);
-
+    getRatio = _provider$getRatio === void 0 ? getPixelRatio : _provider$getRatio,
+    serviceConfig = _objectWithoutProperties(provider, _excluded);
   var scaleQueryParams = calculateScale(getRatio);
-
   var _ref = options || {},
-      _ref$queryParams = _ref.queryParams,
-      queryParams = _ref$queryParams === void 0 ? {} : _ref$queryParams,
-      otherOptions = _objectWithoutProperties(_ref, _excluded2);
-
+    _ref$queryParams = _ref.queryParams,
+    queryParams = _ref$queryParams === void 0 ? {} : _ref$queryParams,
+    otherOptions = _objectWithoutProperties(_ref, _excluded2);
   var requestOptions = _objectSpread(_objectSpread({}, otherOptions), {}, {
     queryParams: _objectSpread(_objectSpread(_objectSpread({}, scaleQueryParams), queryParams), {}, {
       preferredRepresentation: 'IMAGE'
     })
   });
-
   return serviceUtils.requestService(serviceConfig, requestOptions);
 };
-
 var calculateScale = function calculateScale(getRatio) {
   // Retina display
   if (getRatio() > 1) {
@@ -40,19 +32,16 @@ var calculateScale = function calculateScale(getRatio) {
       scale: 'XHDPI',
       altScale: 'XXXHDPI'
     };
-  } // Default set used for desktop
-
-
+  }
+  // Default set used for desktop
   return {
     altScale: 'XHDPI'
   };
 };
-
 export var getPixelRatio = function getPixelRatio() {
   if (typeof window === 'undefined') {
     return 0;
   }
-
   return window.devicePixelRatio;
 };
 export var getAltRepresentation = function getAltRepresentation(reps) {
@@ -65,15 +54,14 @@ export var isMediaApiUrl = function isMediaApiUrl(url, meta) {
 export var denormaliseServiceRepresentation = function denormaliseServiceRepresentation(representation, meta) {
   if (isSpriteServiceRepresentation(representation) && meta && meta.spriteSheets) {
     var _ref2 = representation,
-        height = _ref2.height,
-        width = _ref2.width,
-        x = _ref2.x,
-        y = _ref2.y,
-        xIndex = _ref2.xIndex,
-        yIndex = _ref2.yIndex,
-        spriteRef = _ref2.spriteRef;
+      height = _ref2.height,
+      width = _ref2.width,
+      x = _ref2.x,
+      y = _ref2.y,
+      xIndex = _ref2.xIndex,
+      yIndex = _ref2.yIndex,
+      spriteRef = _ref2.spriteRef;
     var spriteSheet = meta.spriteSheets[spriteRef];
-
     if (spriteSheet) {
       return {
         sprite: spriteSheet,
@@ -87,20 +75,17 @@ export var denormaliseServiceRepresentation = function denormaliseServiceReprese
     }
   } else if (isImageRepresentation(representation)) {
     var _height = representation.height,
-        _width = representation.width,
-        imagePath = representation.imagePath;
-
+      _width = representation.width,
+      imagePath = representation.imagePath;
     if (isMediaApiUrl(imagePath, meta)) {
       return convertImageToMediaRepresentation(representation);
     }
-
     return {
       height: _height,
       width: _width,
       imagePath: imagePath
     };
   }
-
   debug('failed conversion for representation', representation, meta);
   return undefined;
 };
@@ -111,14 +96,12 @@ export var denormaliseSkinEmoji = function denormaliseSkinEmoji(emoji, meta) {
   if (!emoji.skinVariations) {
     return [];
   }
-
   var skinEmoji = emoji.skinVariations;
   var baseId = emoji.id;
   return skinEmoji.map(function (skin) {
     var representation = skin.representation,
-        altRepresentations = skin.altRepresentations,
-        other = _objectWithoutProperties(skin, _excluded3);
-
+      altRepresentations = skin.altRepresentations,
+      other = _objectWithoutProperties(skin, _excluded3);
     return _objectSpread({
       baseId: baseId,
       representation: denormaliseServiceRepresentation(representation, meta),
@@ -126,27 +109,26 @@ export var denormaliseSkinEmoji = function denormaliseSkinEmoji(emoji, meta) {
     }, other);
   });
 };
+
 /**
  * Denormalised an emoji response (emojis + sprite references) into an array of
  * emoji with local sprite definitions.
  */
-
 export var denormaliseEmojiServiceResponse = function denormaliseEmojiServiceResponse(emojiData) {
   var emojis = emojiData.emojis.map(function (emoji) {
     var newRepresentation = denormaliseServiceRepresentation(emoji.representation, emojiData.meta);
     var altRepresentation = denormaliseServiceAltRepresentation(emoji.altRepresentations, emojiData.meta);
-    var newSkinVariations = denormaliseSkinEmoji(emoji, emojiData.meta); // create trimmedServiceDesc which is emoji with no representations or skinVariations
+    var newSkinVariations = denormaliseSkinEmoji(emoji, emojiData.meta);
 
+    // create trimmedServiceDesc which is emoji with no representations or skinVariations
     var representation = emoji.representation,
-        skinVariations = emoji.skinVariations,
-        altRepresentations = emoji.altRepresentations,
-        trimmedServiceDesc = _objectWithoutProperties(emoji, _excluded4);
-
+      skinVariations = emoji.skinVariations,
+      altRepresentations = emoji.altRepresentations,
+      trimmedServiceDesc = _objectWithoutProperties(emoji, _excluded4);
     var response = _objectSpread(_objectSpread({}, trimmedServiceDesc), {}, {
       representation: newRepresentation,
       skinVariations: newSkinVariations
     });
-
     return buildEmojiDescriptionWithAltRepresentation(response, altRepresentation);
   });
   var mediaApiToken = emojiData.meta && emojiData.meta.mediaApiToken;
@@ -155,11 +137,9 @@ export var denormaliseEmojiServiceResponse = function denormaliseEmojiServiceRes
     mediaApiToken: mediaApiToken
   };
 };
-
 var getHeight = function getHeight(fitToHeight) {
   return getPixelRatio() > 1 ? fitToHeight * 2 : fitToHeight;
 };
-
 export var shouldUseAltRepresentation = function shouldUseAltRepresentation(emoji, fitToHeight) {
   return !!(fitToHeight && emoji.altRepresentation && getHeight(fitToHeight) > emoji.representation.height);
 };

package/dist/esm/api/internal/Comparators.js

@@ -3,7 +3,6 @@ import _createClass from "@babel/runtime/helpers/createClass";
 import _construct from "@babel/runtime/helpers/construct";
 import { MAX_ORDINAL } from '../../util/constants';
 import { isEmojiVariationDescription } from '../../util/type-helpers';
-
 /**
  * Create the default sort comparator to be used for the user queries against emoji
  *
@@ -14,29 +13,24 @@ import { isEmojiVariationDescription } from '../../util/type-helpers';
 export function createSearchEmojiComparator(query, orderedIds) {
   var textQuery = query ? query.replace(/:/g, '').toLowerCase().trim() : undefined;
   var comparators = [];
-
   if (query) {
     comparators.push(new AsciiMatchComparator(query));
-  } // Add the comparators to the 'chain'. The order of adding each comparator is important to the sort that is applied by the
-  // ChainedEmojiComparator. (Which is why you may see the same 'if' a few times.)
+  }
 
+  // Add the comparators to the 'chain'. The order of adding each comparator is important to the sort that is applied by the
+  // ChainedEmojiComparator. (Which is why you may see the same 'if' a few times.)
 
   if (textQuery) {
     comparators.push(new ExactShortNameMatchComparator(textQuery));
   }
-
   if (orderedIds && orderedIds.length) {
     comparators.push(new UsageFrequencyComparator(orderedIds));
   }
-
   if (textQuery) {
     comparators.push(new QueryStringPositionMatchComparator(textQuery, 'shortName'), new QueryStringPositionMatchComparator(textQuery, 'name'));
   }
-
   comparators.push(OrderComparator.Instance, AlphabeticalShortnameComparator.Instance);
-
   var comparator = _construct(ChainedEmojiComparator, comparators);
-
   comparator.compare = comparator.compare.bind(comparator);
   return comparator;
 }
@@ -45,6 +39,7 @@ export function createUsageOnlyEmojiComparator(orderedIds) {
   comparator.compare = comparator.compare.bind(comparator);
   return comparator;
 }
+
 /**
  * Returns a number representing the result of comparing e1 and e2.
  * Compatible with Array.sort, which is to say -
@@ -63,74 +58,61 @@ export function createUsageOnlyEmojiComparator(orderedIds) {
 export var ChainedEmojiComparator = /*#__PURE__*/function () {
   function ChainedEmojiComparator() {
     _classCallCheck(this, ChainedEmojiComparator);
-
     for (var _len = arguments.length, comparators = new Array(_len), _key = 0; _key < _len; _key++) {
       comparators[_key] = arguments[_key];
     }
-
     this.chain = comparators;
   }
-
   _createClass(ChainedEmojiComparator, [{
     key: "compare",
     value: function compare(e1, e2) {
       for (var i = 0; i < this.chain.length; i++) {
         var result = this.chain[i].compare(e1, e2);
-
         if (result !== 0) {
           return result;
         }
       }
-
       return 0;
     }
   }]);
-
   return ChainedEmojiComparator;
 }();
+
 /**
  * Orders two emoji such that if one of them has an ascii representation that exactly matches the query then it will
  * be ordered first.
  */
-
 export var AsciiMatchComparator = /*#__PURE__*/function () {
   function AsciiMatchComparator(query) {
     _classCallCheck(this, AsciiMatchComparator);
-
     this.query = query;
   }
-
   _createClass(AsciiMatchComparator, [{
     key: "compare",
     value: function compare(e1, e2) {
       var e1HasAscii = e1.ascii && e1.ascii.indexOf(this.query) !== -1;
       var e2HasAscii = e2.ascii && e2.ascii.indexOf(this.query) !== -1;
-
       if (e1HasAscii && !e2HasAscii) {
         return -1;
       } else if (!e1HasAscii && e2HasAscii) {
         return 1;
       }
-
       return 0;
     }
   }]);
-
   return AsciiMatchComparator;
 }();
+
 /**
  * Orders two emoji such that the one who's shortname matches the query exactly comes first. If there are matching
  * shortnames then the type of emoji is taken into account with SITE emoji coming first.
  */
-
 export var ExactShortNameMatchComparator = /*#__PURE__*/function () {
   function ExactShortNameMatchComparator(query) {
     _classCallCheck(this, ExactShortNameMatchComparator);
-
     this.colonQuery = ":".concat(query, ":");
     this.typeComparator = new EmojiTypeComparator(true);
   }
-
   _createClass(ExactShortNameMatchComparator, [{
     key: "compare",
     value: function compare(e1, e2) {
@@ -141,31 +123,27 @@ export var ExactShortNameMatchComparator = /*#__PURE__*/function () {
       } else if (e2.shortName === this.colonQuery) {
         return 1;
       }
-
       return 0;
     }
   }]);
-
   return ExactShortNameMatchComparator;
 }();
+
 /**
  * Orders two emoji based on their type, with the types being STANDARD, ATLASSIAN and SITE (in that order).
  * If the comparator is configured to 'reverse' then the order will be SITE, ATLASSIAN, STANDARD.
  *
  * Regardless of the reverse setting, an unknown type will always come last.
  */
-
 export var EmojiTypeComparator = /*#__PURE__*/function () {
   function EmojiTypeComparator(reverse) {
     _classCallCheck(this, EmojiTypeComparator);
-
     if (reverse) {
       this.typeToNumber = new Map([['SITE', 0], ['ATLASSIAN', 1], ['STANDARD', 2]]);
     } else {
       this.typeToNumber = new Map([['STANDARD', 0], ['ATLASSIAN', 1], ['SITE', 2]]);
     }
   }
-
   _createClass(EmojiTypeComparator, [{
     key: "compare",
     value: function compare(e1, e2) {
@@ -175,36 +153,31 @@ export var EmojiTypeComparator = /*#__PURE__*/function () {
     key: "emojiTypeToOrdinal",
     value: function emojiTypeToOrdinal(emoji) {
       var ordinal = this.typeToNumber.get(emoji.type);
-
       if (ordinal === undefined) {
         ordinal = 10;
       }
-
       return ordinal;
     }
   }]);
-
   return EmojiTypeComparator;
 }();
+
 /**
  * Order two emoji such as the one which is more frequently used comes first. If neither have any usage
  * information then leave their order unchanged.
  */
-
 export var UsageFrequencyComparator = /*#__PURE__*/function () {
   // A Map of emoji base Id to their order in a least of most frequently used
+
   function UsageFrequencyComparator(orderedIds) {
     var _this = this;
-
     _classCallCheck(this, UsageFrequencyComparator);
-
-    this.positionLookup = new Map(); // Make ordering start from 1 to avoid having zero in the map (which is falsey)
-
+    this.positionLookup = new Map();
+    // Make ordering start from 1 to avoid having zero in the map (which is falsey)
     orderedIds.map(function (id, index) {
       return _this.positionLookup.set(id, index + 1);
     });
   }
-
   _createClass(UsageFrequencyComparator, [{
     key: "compare",
     value: function compare(e1, e2) {
@@ -216,23 +189,20 @@ export var UsageFrequencyComparator = /*#__PURE__*/function () {
       var i2 = this.getPositionInOrder(e2);
       return i1 - i2;
     }
+
     /**
      * Get the ordinal representing the position of this emoji.
      *
      * @param id the id of the emoji
      */
-
   }, {
     key: "getPositionInOrder",
     value: function getPositionInOrder(emoji) {
       var id = emoji.id ? emoji.id : '0';
-
       if (isEmojiVariationDescription(emoji)) {
         id = emoji.baseId;
       }
-
       var position = this.positionLookup.get(id);
-
       if (position) {
         return position;
       } else {
@@ -240,10 +210,8 @@ export var UsageFrequencyComparator = /*#__PURE__*/function () {
       }
     }
   }]);
-
   return UsageFrequencyComparator;
 }();
-
 /**
  * A comparator that will sort higher an emoji which matches the query string earliest in the indicated
  * property.
@@ -255,16 +223,12 @@ export var QueryStringPositionMatchComparator = /*#__PURE__*/function () {
    */
   function QueryStringPositionMatchComparator(query, propertyToCompare) {
     _classCallCheck(this, QueryStringPositionMatchComparator);
-
     this.query = query;
-
     if (!propertyToCompare) {
       throw new Error('propertyToCompare is required');
     }
-
     this.propertyName = propertyToCompare;
   }
-
   _createClass(QueryStringPositionMatchComparator, [{
     key: "getScore",
     value: function getScore(emoji) {
@@ -280,14 +244,12 @@ export var QueryStringPositionMatchComparator = /*#__PURE__*/function () {
       return this.getScore(e1) - this.getScore(e2);
     }
   }]);
-
   return QueryStringPositionMatchComparator;
 }();
 export var OrderComparator = /*#__PURE__*/function () {
   function OrderComparator() {
     _classCallCheck(this, OrderComparator);
   }
-
   _createClass(OrderComparator, [{
     key: "compare",
     value: function compare(e1, e2) {
@@ -301,14 +263,12 @@ export var OrderComparator = /*#__PURE__*/function () {
       return this.INSTANCE || (this.INSTANCE = new this());
     }
   }]);
-
   return OrderComparator;
 }();
 export var AlphabeticalShortnameComparator = /*#__PURE__*/function () {
   function AlphabeticalShortnameComparator() {
     _classCallCheck(this, AlphabeticalShortnameComparator);
   }
-
   _createClass(AlphabeticalShortnameComparator, [{
     key: "compare",
     value: function compare(e1, e2) {
@@ -320,6 +280,5 @@ export var AlphabeticalShortnameComparator = /*#__PURE__*/function () {
       return this.INSTANCE || (this.INSTANCE = new this());
     }
   }]);
-
   return AlphabeticalShortnameComparator;
 }();

package/dist/esm/api/internal/UsageFrequencyTracker.js

@@ -1,16 +1,14 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-
 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) { _defineProperty(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; }
-
 import { isEmojiVariationDescription } from '../../util/type-helpers';
 import { localStoragePrefix } from '../../util/constants';
 import DuplicateLimitedQueue from '../../util/DuplicateLimitedQueue';
 import StoredDuplicateLimitedQueue from '../../util/StoredDuplicateLimitedQueue';
 import storageAvailable from '../../util/storage-available';
+
 /**
  * Keeps track of the last 150 emoji usages, although limiting the maximum count for a single emoji to 25 to
  * ensure we don't end up with only a single emoji being recorded. Usage is persisted to local storage for
@@ -20,47 +18,37 @@ import storageAvailable from '../../util/storage-available';
  * variations are not collapsed in this way and will be tracked per gender. This decision reflects the UI of
  * the EmojiPicker component.
  */
-
 export var UsageFrequencyTracker = /*#__PURE__*/function () {
   function UsageFrequencyTracker() {
     var useStorageIfPossible = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
-
     _classCallCheck(this, UsageFrequencyTracker);
-
     var options = UsageFrequencyTracker.queueOptions;
-
     if (useStorageIfPossible && options.storage) {
       var queueOptions = _objectSpread(_objectSpread({}, options), {}, {
         storage: options.storage
       });
-
       this.queue = new StoredDuplicateLimitedQueue(queueOptions);
     } else {
       this.queue = new DuplicateLimitedQueue(options);
     }
-
     this.gateway = new Gateway(10);
   }
+
   /**
    * Record the fact that the supplied emoji was used. You should note that usage is updated asynchronously so you can not
    * count on getOrder() reflecting this usage immediately.
    *
    * @param emoji the emoji who's usage is to be recorded. If the emoji has no id then no usage will be recorded
    */
-
-
   _createClass(UsageFrequencyTracker, [{
     key: "recordUsage",
     value: function recordUsage(emoji) {
       var _this = this;
-
       var emojiId = emoji.id;
-
       if (emojiId) {
         if (isEmojiVariationDescription(emoji)) {
           emojiId = emoji.baseId;
         }
-
         this.gateway.submit(function () {
           if (emojiId) {
             _this.queue.enqueue(emojiId);
@@ -68,67 +56,58 @@ export var UsageFrequencyTracker = /*#__PURE__*/function () {
         });
       }
     }
+
     /**
      * Returns an array of emoji id (without skin tone variations) sorted by most used to least used. If there
      * are no usages then an empty array will be returned.
      */
-
   }, {
     key: "getOrder",
     value: function getOrder() {
       return this.queue.getItemsOrderedByDuplicateCount();
     }
+
     /**
      * Exposed for testing only. Clear any recorded usage.
      */
-
   }, {
     key: "clear",
     value: function clear() {
       this.queue.clear();
     }
   }]);
-
   return UsageFrequencyTracker;
 }();
-
 _defineProperty(UsageFrequencyTracker, "queueOptions", {
   storage: storageAvailable('localStorage') ? window.localStorage : undefined,
   storagePrefix: localStoragePrefix,
   maxDuplicates: 25,
   minUniqueItems: 5
 });
-
 export var Gateway = /*#__PURE__*/function () {
   function Gateway(maximumPermitted) {
     _classCallCheck(this, Gateway);
-
     if (maximumPermitted < 1) {
       throw new RangeError('The maximumPermitted parameter must be 1 or more.');
     }
-
     this.maximumPermitted = maximumPermitted;
     this.count = 0;
   }
+
   /**
    * Run the supplied function if the count of already submitted work allows it. Drop the work
    * if it's not allowed to run.
    *
    * Will return true if the function has been submitted or false if it was not submitted.
    */
-
-
   _createClass(Gateway, [{
     key: "submit",
     value: function submit(f) {
       var _this2 = this;
-
       if (this.count >= this.maximumPermitted) {
         return false;
       }
-
       this.count++;
-
       var wrappedFunc = function wrappedFunc() {
         try {
           f();
@@ -136,11 +115,9 @@ export var Gateway = /*#__PURE__*/function () {
           _this2.completed();
         }
       };
-
       if (typeof window !== 'undefined') {
         window.setTimeout(wrappedFunc);
       }
-
       return true;
     }
   }, {
@@ -149,6 +126,5 @@ export var Gateway = /*#__PURE__*/function () {
       this.count--;
     }
   }]);
-
   return Gateway;
 }();