@atlaskit/emoji 71.17.1 → 72.0.0

package/dist/es2019/api/EmojiUtils.js

@@ -1,169 +1,46 @@
-import { utils as serviceUtils } from '@atlaskit/util-service-support';
-import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
-import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
-import { ProviderTypes } from '../types';
-import { isImageRepresentation, isSpriteServiceRepresentation, convertImageToMediaRepresentation, buildEmojiDescriptionWithAltRepresentation } from '../util/type-helpers';
-import debug from '../util/logger';
-import { emojiIdToEmoji } from '../util/emojiIdToEmoji';
-export const emojiRequest = (provider, options) => {
-  const {
-    getRatio = getPixelRatio,
-    ...serviceConfig
-  } = provider;
-  const scaleQueryParams = calculateScale(getRatio);
-  const {
-    queryParams = {},
-    ...otherOptions
-  } = options || {};
-  const requestOptions = {
-    ...otherOptions,
-    queryParams: {
-      ...scaleQueryParams,
-      ...queryParams,
-      preferredRepresentation: 'IMAGE'
-    }
-  };
-  return serviceUtils.requestService(serviceConfig, requestOptions);
-};
-const calculateScale = getRatio => {
-  if (expValEquals('platform_editor_emoji_default_scale', 'isEnabled', true)) {
-    // retina display
-    if (getRatio() > 1) {
-      return {
-        scale: 'XXXHDPI',
-        altScale: 'XXXHDPI'
-      };
-    }
-    // default set used for desktop
-    return {
-      altScale: 'XXXHDPI'
-    };
-  }
-
-  // Retina display
-  if (getRatio() > 1) {
-    return {
-      scale: 'XHDPI',
-      altScale: 'XXXHDPI'
-    };
-  }
-  // Default set used for desktop
-  return {
-    altScale: 'XHDPI'
-  };
-};
-export const getPixelRatio = () => {
-  if (typeof window === 'undefined') {
-    return 0;
-  }
-  return window.devicePixelRatio;
-};
-export const getAltRepresentation = reps => {
-  // Invalid reps handled outside function - logic may change depending what the service returns
-  return reps[calculateScale(getPixelRatio).altScale];
-};
-export const isMediaApiUrl = (url, meta) => !!(meta && meta.mediaApiToken && url.indexOf(meta.mediaApiToken.url) === 0);
-export const denormaliseServiceRepresentation = (representation, meta) => {
-  if (isSpriteServiceRepresentation(representation) && meta && meta.spriteSheets) {
-    const {
-      height,
-      width,
-      x,
-      y,
-      xIndex,
-      yIndex,
-      spriteRef
-    } = representation;
-    const spriteSheet = meta.spriteSheets[spriteRef];
-    if (spriteSheet) {
-      return {
-        sprite: spriteSheet,
-        height,
-        width,
-        x,
-        y,
-        xIndex,
-        yIndex
-      };
-    }
-  } else if (isImageRepresentation(representation)) {
-    const {
-      height,
-      width,
-      imagePath
-    } = representation;
-    if (isMediaApiUrl(imagePath, meta)) {
-      return convertImageToMediaRepresentation(representation);
-    }
-    return {
-      height,
-      width,
-      imagePath
-    };
-  }
-  debug('failed conversion for representation', representation, meta);
-  return undefined;
-};
-export const denormaliseServiceAltRepresentation = (altReps, meta) => {
-  return !altReps || Object.keys(altReps).length === 0 ? undefined : denormaliseServiceRepresentation(getAltRepresentation(altReps), meta);
-};
-const denormaliseStandardRepresentation = (emoji, meta) => {
-  const unicodeEmoji = emojiIdToEmoji(emoji.id);
-  const useUnicodeRepresentation = !!(emoji.id && emoji.type === ProviderTypes.STANDARD && unicodeEmoji && expValEqualsNoExposure('platform_use_unicode_emojis', 'isEnabled', true));
-  return useUnicodeRepresentation ? {
-    unicodeEmoji
-  } : denormaliseServiceRepresentation(emoji.representation, meta);
-};
-export const denormaliseSkinEmoji = (emoji, meta) => {
-  if (!emoji.skinVariations) {
-    return [];
-  }
-  const skinEmoji = emoji.skinVariations;
-  const baseId = emoji.id;
-  return skinEmoji.map(skin => {
-    const {
-      representation: _representation,
-      altRepresentations,
-      ...other
-    } = skin;
-    return {
-      baseId: baseId,
-      representation: denormaliseStandardRepresentation(skin, meta),
-      altRepresentation: denormaliseServiceAltRepresentation(altRepresentations, meta),
-      ...other
-    };
-  });
-};
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
 
 /**
- * Denormalised an emoji response (emojis + sprite references) into an array of
- * emoji with local sprite definitions.
+ * @deprecated Use `import { emojiRequest } from '@atlaskit/emoji/emoji-utils'` instead.
  */
-export const denormaliseEmojiServiceResponse = emojiData => {
-  const emojis = emojiData.emojis.map(emoji => {
-    const newRepresentation = denormaliseStandardRepresentation(emoji, emojiData.meta);
-    const altRepresentation = denormaliseServiceAltRepresentation(emoji.altRepresentations, emojiData.meta);
-    const newSkinVariations = denormaliseSkinEmoji(emoji, emojiData.meta);
-
-    // create trimmedServiceDesc which is emoji with no representations or skinVariations
-    const {
-      representation: _representation,
-      skinVariations: _skinVariations,
-      altRepresentations: _altRepresentations,
-      ...trimmedServiceDesc
-    } = emoji;
-    const response = {
-      ...trimmedServiceDesc,
-      representation: newRepresentation,
-      skinVariations: newSkinVariations
-    };
-    return buildEmojiDescriptionWithAltRepresentation(response, altRepresentation);
-  });
-  const mediaApiToken = emojiData.meta && emojiData.meta.mediaApiToken;
-  return {
-    emojis,
-    mediaApiToken
-  };
-};
-const getHeight = fitToHeight => getPixelRatio() > 1 ? fitToHeight * 2 : fitToHeight;
-export const shouldUseAltRepresentation = (emoji, fitToHeight) => !!(fitToHeight && emoji.altRepresentation && emoji.representation && 'height' in emoji.representation && getHeight(fitToHeight) > emoji.representation.height);
+export { emojiRequest } from './emojiRequest';
+/**
+ * @deprecated Use `import { getPixelRatio } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { getPixelRatio } from './getPixelRatio';
+/**
+ * @deprecated Use `import { getAltRepresentation } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { getAltRepresentation } from './getAltRepresentation';
+/**
+ * @deprecated Use `import { isMediaApiUrl } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { isMediaApiUrl } from './isMediaApiUrl';
+/**
+ * @deprecated Use `import { denormaliseServiceRepresentation } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { denormaliseServiceRepresentation } from './denormaliseServiceRepresentation';
+/**
+ * @deprecated Use `import { denormaliseServiceAltRepresentation } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { denormaliseServiceAltRepresentation } from './denormaliseServiceAltRepresentation';
+/**
+ * @deprecated Use `import { denormaliseSkinEmoji } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { denormaliseSkinEmoji } from './denormaliseSkinEmoji';
+/**
+ * @deprecated Use `import { denormaliseEmojiServiceResponse } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { denormaliseEmojiServiceResponse } from './denormaliseEmojiServiceResponse';
+/**
+ * @deprecated Use `import { shouldUseAltRepresentation } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { shouldUseAltRepresentation } from './shouldUseAltRepresentation';
+/**
+ * @deprecated Use `import { calculateScale } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { calculateScale } from './calculateScale';
+/**
+ * @deprecated Use `import { denormaliseStandardRepresentation } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { denormaliseStandardRepresentation } from './denormaliseStandardRepresentation';

package/dist/es2019/api/calculateScale.js

@@ -0,0 +1,28 @@
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+export const calculateScale = getRatio => {
+  if (expValEquals('platform_editor_emoji_default_scale', 'isEnabled', true)) {
+    // retina display
+    if (getRatio() > 1) {
+      return {
+        scale: 'XXXHDPI',
+        altScale: 'XXXHDPI'
+      };
+    }
+    // default set used for desktop
+    return {
+      altScale: 'XXXHDPI'
+    };
+  }
+
+  // Retina display
+  if (getRatio() > 1) {
+    return {
+      scale: 'XHDPI',
+      altScale: 'XXXHDPI'
+    };
+  }
+  // Default set used for desktop
+  return {
+    altScale: 'XHDPI'
+  };
+};

package/dist/es2019/api/denormaliseEmojiServiceResponse.js

@@ -0,0 +1,35 @@
+import { buildEmojiDescriptionWithAltRepresentation } from '../util/build-emoji-description-with-alt-representation';
+import { denormaliseServiceAltRepresentation } from './denormaliseServiceAltRepresentation';
+import { denormaliseSkinEmoji } from './denormaliseSkinEmoji';
+import { denormaliseStandardRepresentation } from './denormaliseStandardRepresentation';
+
+/**
+ * Denormalised an emoji response (emojis + sprite references) into an array of
+ * emoji with local sprite definitions.
+ */
+export const denormaliseEmojiServiceResponse = emojiData => {
+  const emojis = emojiData.emojis.map(emoji => {
+    const newRepresentation = denormaliseStandardRepresentation(emoji, emojiData.meta);
+    const altRepresentation = denormaliseServiceAltRepresentation(emoji.altRepresentations, emojiData.meta);
+    const newSkinVariations = denormaliseSkinEmoji(emoji, emojiData.meta);
+
+    // create trimmedServiceDesc which is emoji with no representations or skinVariations
+    const {
+      representation: _representation,
+      skinVariations: _skinVariations,
+      altRepresentations: _altRepresentations,
+      ...trimmedServiceDesc
+    } = emoji;
+    const response = {
+      ...trimmedServiceDesc,
+      representation: newRepresentation,
+      skinVariations: newSkinVariations
+    };
+    return buildEmojiDescriptionWithAltRepresentation(response, altRepresentation);
+  });
+  const mediaApiToken = emojiData.meta && emojiData.meta.mediaApiToken;
+  return {
+    emojis,
+    mediaApiToken
+  };
+};

package/dist/es2019/api/denormaliseServiceAltRepresentation.js

@@ -0,0 +1,5 @@
+import { denormaliseServiceRepresentation } from './denormaliseServiceRepresentation';
+import { getAltRepresentation } from './getAltRepresentation';
+export const denormaliseServiceAltRepresentation = (altReps, meta) => {
+  return !altReps || Object.keys(altReps).length === 0 ? undefined : denormaliseServiceRepresentation(getAltRepresentation(altReps), meta);
+};

package/dist/es2019/api/denormaliseServiceRepresentation.js

@@ -0,0 +1,46 @@
+import { convertImageToMediaRepresentation } from '../util/convert-image-to-media-representation';
+import { isImageRepresentation } from '../util/is-image-representation';
+import { isSpriteServiceRepresentation } from '../util/is-sprite-service-representation';
+import debug from '../util/logger';
+import { isMediaApiUrl } from './isMediaApiUrl';
+export const denormaliseServiceRepresentation = (representation, meta) => {
+  if (isSpriteServiceRepresentation(representation) && meta && meta.spriteSheets) {
+    const {
+      height,
+      width,
+      x,
+      y,
+      xIndex,
+      yIndex,
+      spriteRef
+    } = representation;
+    const spriteSheet = meta.spriteSheets[spriteRef];
+    if (spriteSheet) {
+      return {
+        sprite: spriteSheet,
+        height,
+        width,
+        x,
+        y,
+        xIndex,
+        yIndex
+      };
+    }
+  } else if (isImageRepresentation(representation)) {
+    const {
+      height,
+      width,
+      imagePath
+    } = representation;
+    if (isMediaApiUrl(imagePath, meta)) {
+      return convertImageToMediaRepresentation(representation);
+    }
+    return {
+      height,
+      width,
+      imagePath
+    };
+  }
+  debug('failed conversion for representation', representation, meta);
+  return undefined;
+};

package/dist/es2019/api/denormaliseSkinEmoji.js

@@ -0,0 +1,22 @@
+import { denormaliseServiceAltRepresentation } from './denormaliseServiceAltRepresentation';
+import { denormaliseStandardRepresentation } from './denormaliseStandardRepresentation';
+export const denormaliseSkinEmoji = (emoji, meta) => {
+  if (!emoji.skinVariations) {
+    return [];
+  }
+  const skinEmoji = emoji.skinVariations;
+  const baseId = emoji.id;
+  return skinEmoji.map(skin => {
+    const {
+      representation: _representation,
+      altRepresentations,
+      ...other
+    } = skin;
+    return {
+      baseId: baseId,
+      representation: denormaliseStandardRepresentation(skin, meta),
+      altRepresentation: denormaliseServiceAltRepresentation(altRepresentations, meta),
+      ...other
+    };
+  });
+};

package/dist/es2019/api/denormaliseStandardRepresentation.js

@@ -0,0 +1,11 @@
+import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
+import { ProviderTypes } from '../types';
+import { emojiIdToEmoji } from '../util/emojiIdToEmoji';
+import { denormaliseServiceRepresentation } from './denormaliseServiceRepresentation';
+export const denormaliseStandardRepresentation = (emoji, meta) => {
+  const unicodeEmoji = emojiIdToEmoji(emoji.id);
+  const useUnicodeRepresentation = !!(emoji.id && emoji.type === ProviderTypes.STANDARD && unicodeEmoji && expValEqualsNoExposure('platform_use_unicode_emojis', 'isEnabled', true));
+  return useUnicodeRepresentation ? {
+    unicodeEmoji
+  } : denormaliseServiceRepresentation(emoji.representation, meta);
+};

package/dist/es2019/api/emojiRequest.js

@@ -0,0 +1,23 @@
+import { utils as serviceUtils } from '@atlaskit/util-service-support';
+import { calculateScale } from './calculateScale';
+import { getPixelRatio } from './getPixelRatio';
+export const emojiRequest = (provider, options) => {
+  const {
+    getRatio = getPixelRatio,
+    ...serviceConfig
+  } = provider;
+  const scaleQueryParams = calculateScale(getRatio);
+  const {
+    queryParams = {},
+    ...otherOptions
+  } = options || {};
+  const requestOptions = {
+    ...otherOptions,
+    queryParams: {
+      ...scaleQueryParams,
+      ...queryParams,
+      preferredRepresentation: 'IMAGE'
+    }
+  };
+  return serviceUtils.requestService(serviceConfig, requestOptions);
+};

package/dist/es2019/api/getAltRepresentation.js

@@ -0,0 +1,6 @@
+import { calculateScale } from './calculateScale';
+import { getPixelRatio } from './getPixelRatio';
+export const getAltRepresentation = reps => {
+  // Invalid reps handled outside function - logic may change depending what the service returns
+  return reps[calculateScale(getPixelRatio).altScale];
+};

package/dist/es2019/api/getEmojiVariation.js

@@ -0,0 +1,13 @@
+import { isEmojiDescriptionWithVariations } from '../util/is-emoji-description-with-variations';
+export const getEmojiVariation = (emoji, options) => {
+  if (isEmojiDescriptionWithVariations(emoji) && options) {
+    const skinTone = options.skinTone;
+    if (skinTone && emoji.skinVariations && emoji.skinVariations.length) {
+      const skinToneEmoji = emoji.skinVariations[skinTone - 1]; // skinTone start at 1
+      if (skinToneEmoji) {
+        return skinToneEmoji;
+      }
+    }
+  }
+  return emoji;
+};

package/dist/es2019/api/getPixelRatio.js

@@ -0,0 +1,6 @@
+export const getPixelRatio = () => {
+  if (typeof window === 'undefined') {
+    return 0;
+  }
+  return window.devicePixelRatio;
+};

package/dist/es2019/api/internal/AlphabeticalShortnameComparator.js

@@ -0,0 +1,9 @@
+export class AlphabeticalShortnameComparator {
+  constructor() {}
+  static get Instance() {
+    return this.INSTANCE || (this.INSTANCE = new this());
+  }
+  compare(e1, e2) {
+    return e1.shortName.localeCompare(e2.shortName);
+  }
+}

package/dist/es2019/api/internal/AsciiMatchComparator.js

@@ -0,0 +1,19 @@
+/**
+ * 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 class AsciiMatchComparator {
+  constructor(query) {
+    this.query = query;
+  }
+  compare(e1, e2) {
+    const e1HasAscii = e1.ascii && e1.ascii.indexOf(this.query) !== -1;
+    const e2HasAscii = e2.ascii && e2.ascii.indexOf(this.query) !== -1;
+    if (e1HasAscii && !e2HasAscii) {
+      return -1;
+    } else if (!e1HasAscii && e2HasAscii) {
+      return 1;
+    }
+    return 0;
+  }
+}

package/dist/es2019/api/internal/ChainedEmojiComparator.js

@@ -0,0 +1,21 @@
+/**
+ * A combinator comparator that applies an ordered chained of sub-comparators. The first comparator that
+ * returns a non-zero value stops the chain and causes that value to be returned. If a comparator returns a
+ * zero then the next one in the chain is tried.
+ *
+ * If no comparators in the chain return a non-zero value then zero will be returned.
+ */
+export class ChainedEmojiComparator {
+  constructor(...comparators) {
+    this.chain = comparators;
+  }
+  compare(e1, e2) {
+    for (let i = 0; i < this.chain.length; i++) {
+      const result = this.chain[i].compare(e1, e2);
+      if (result !== 0) {
+        return result;
+      }
+    }
+    return 0;
+  }
+}