@atlaskit/emoji 71.17.0 → 72.0.0

package/dist/esm/util/type-helpers.js

@@ -1,113 +1,89 @@
-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 { messages } from '../components/i18n';
-import { customCategory, dataURLPrefix } from './constants';
-export var isSpriteServiceRepresentation = function isSpriteServiceRepresentation(rep) {
-  return !!(rep && rep.spriteRef);
-};
-export var isSpriteRepresentation = function isSpriteRepresentation(rep) {
-  return !!(rep && rep.sprite);
-};
-export var isImageRepresentation = function isImageRepresentation(rep) {
-  return !!(rep && rep.imagePath);
-};
-export var isMediaRepresentation = function isMediaRepresentation(rep) {
-  return !!(rep && rep.mediaPath);
-};
-export var isUnicodeRepresentation = function isUnicodeRepresentation(rep) {
-  return !!(rep && rep.unicodeEmoji);
-};
-export var isPromise = function isPromise(p) {
-  return !!(p && p.then);
-};
-export var isEmojiDescription = function isEmojiDescription(possibleEmojiDescription) {
-  return possibleEmojiDescription && possibleEmojiDescription.shortName && possibleEmojiDescription.type;
-};
-export var isMediaEmoji = function isMediaEmoji(emoji) {
-  return isMediaRepresentation(emoji.representation);
-};
-export var hasDataURLImage = function hasDataURLImage(rep) {
-  return isImageRepresentation(rep) && rep.imagePath.indexOf(dataURLPrefix) === 0;
-};
-export var isLoadedMediaEmoji = function isLoadedMediaEmoji(emoji) {
-  return emoji.category === customCategory && hasDataURLImage(emoji.representation);
-};
-export var isEmojiDescriptionWithVariations = function isEmojiDescriptionWithVariations(emoji) {
-  return !!(emoji && emoji.skinVariations);
-};
-export var isEmojiVariationDescription = function isEmojiVariationDescription(object) {
-  return 'baseId' in object;
-};
-export var isMessagesKey = function isMessagesKey(key) {
-  return key in messages;
-};
-export var toEmojiId = function toEmojiId(emoji) {
-  return {
-    shortName: emoji.shortName,
-    id: emoji.id,
-    fallback: emoji.fallback
-  };
-};
-export var toOptionalEmojiId = function toOptionalEmojiId(emoji) {
-  if (!emoji) {
-    return undefined;
-  }
-  return toEmojiId(emoji);
-};
-export var isEmojiIdEqual = function isEmojiIdEqual(l, r) {
-  return l === r || l && r && l.id === r.id && l.shortName === r.shortName;
-};
-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;
-};
-export var convertImageToMediaRepresentation = function convertImageToMediaRepresentation(rep) {
-  return {
-    mediaPath: rep.imagePath,
-    height: rep.height,
-    width: rep.width
-  };
-};
-export var convertMediaToImageRepresentation = function convertMediaToImageRepresentation(rep, newImagePath) {
-  return {
-    imagePath: newImagePath || rep.mediaPath,
-    height: rep.height,
-    width: rep.width
-  };
-};
-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);
-};
-
-// 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
-  });
-};
-export var getCategoryId = function getCategoryId(emoji) {
-  return emoji.category;
-};
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+/**
+ * @deprecated Use `import { isSpriteServiceRepresentation } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isSpriteServiceRepresentation } from './is-sprite-service-representation';
+/**
+ * @deprecated Use `import { isSpriteRepresentation } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isSpriteRepresentation } from './is-sprite-representation';
+/**
+ * @deprecated Use `import { isImageRepresentation } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isImageRepresentation } from './is-image-representation';
+/**
+ * @deprecated Use `import { isMediaRepresentation } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isMediaRepresentation } from './is-media-representation';
+/**
+ * @deprecated Use `import { isUnicodeRepresentation } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isUnicodeRepresentation } from './is-unicode-representation';
+/**
+ * @deprecated Use `import { isPromise } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isPromise } from './is-promise';
+/**
+ * @deprecated Use `import { isEmojiDescription } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isEmojiDescription } from './is-emoji-description';
+/**
+ * @deprecated Use `import { isMediaEmoji } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isMediaEmoji } from './is-media-emoji';
+/**
+ * @deprecated Use `import { hasDataURLImage } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { hasDataURLImage } from './has-data-url-image';
+/**
+ * @deprecated Use `import { isLoadedMediaEmoji } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isLoadedMediaEmoji } from './is-loaded-media-emoji';
+/**
+ * @deprecated Use `import { isEmojiDescriptionWithVariations } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isEmojiDescriptionWithVariations } from './is-emoji-description-with-variations';
+/**
+ * @deprecated Use `import { isEmojiVariationDescription } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isEmojiVariationDescription } from './is-emoji-variation-description';
+/**
+ * @deprecated Use `import { isMessagesKey } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isMessagesKey } from './is-messages-key';
+/**
+ * @deprecated Use `import { toEmojiId } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { toEmojiId } from './to-emoji-id';
+/**
+ * @deprecated Use `import { toOptionalEmojiId } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { toOptionalEmojiId } from './to-optional-emoji-id';
+/**
+ * @deprecated Use `import { isEmojiIdEqual } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { isEmojiIdEqual } from './is-emoji-id-equal';
+/**
+ * @deprecated Use `import { containsEmojiId } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { containsEmojiId } from './contains-emoji-id';
+/**
+ * @deprecated Use `import { convertImageToMediaRepresentation } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { convertImageToMediaRepresentation } from './convert-image-to-media-representation';
+/**
+ * @deprecated Use `import { convertMediaToImageRepresentation } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { convertMediaToImageRepresentation } from './convert-media-to-image-representation';
+/**
+ * @deprecated Use `import { convertMediaToImageEmoji } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { convertMediaToImageEmoji } from './convert-media-to-image-emoji';
+/**
+ * @deprecated Use `import { buildEmojiDescriptionWithAltRepresentation } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { buildEmojiDescriptionWithAltRepresentation } from './build-emoji-description-with-alt-representation';
+/**
+ * @deprecated Use `import { getCategoryId } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { getCategoryId } from './get-category-id';

package/dist/esm/utils.js

@@ -1,4 +1,18 @@
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+/**
+ * @deprecated Use `import { defaultInlineEmojiHeight } from '@atlaskit/emoji/constants'` instead.
+ */
 export { defaultInlineEmojiHeight } from './util/constants';
-export { toEmojiId, toOptionalEmojiId } from './util/type-helpers';
-export { denormaliseEmojiServiceResponse } from './api/EmojiUtils';
+/**
+ * @deprecated Use `import { toEmojiId, toOptionalEmojiId } from '@atlaskit/emoji/type-helpers'` instead.
+ */
+export { toEmojiId } from './util/to-emoji-id';
+export { toOptionalEmojiId } from './util/to-optional-emoji-id';
+/**
+ * @deprecated Use `import { denormaliseEmojiServiceResponse } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+export { denormaliseEmojiServiceResponse } from './api/denormaliseEmojiServiceResponse';
+/**
+ * @deprecated Use `import { UsageFrequencyTracker } from '@atlaskit/emoji/usage-frequency-tracker'` instead.
+ */
 export { UsageFrequencyTracker } from './api/internal/UsageFrequencyTracker';

package/dist/types/admin.d.ts

@@ -1 +1,4 @@
+/**
+ * @deprecated Use `import { EmojiUploader } from '@atlaskit/emoji/emoji-uploader'` instead.
+ */
 export { default as EmojiUploader } from './components/uploader/EmojiUploader';

package/dist/types/api/EmojiLoader.d.ts

@@ -1,5 +1,5 @@
 import type { EmojiResponse } from '../types';
-import { type EmojiLoaderConfig } from './EmojiUtils';
+import type { EmojiLoaderConfig } from './EmojiUtils';
 /**
  * Emoji providers should return JSON in the format defined by EmojiServiceResponse.
  */

package/dist/types/api/EmojiRepository.d.ts

@@ -1,7 +1,6 @@
 import type { CategoryId } from '../components/picker/categories';
 import { type EmojiDescription, type EmojiSearchResult, type OptionalEmojiDescription, type SearchOptions } from '../types';
 import { UsageFrequencyTracker } from './internal/UsageFrequencyTracker';
-export declare const getEmojiVariation: (emoji: EmojiDescription, options?: SearchOptions) => EmojiDescription;
 export default class EmojiRepository {
     private emojis;
     private fullSearch;
@@ -73,3 +72,7 @@ export default class EmojiRepository {
     private addToDynamicCategories;
     private getDynamicCategoryForEmoji;
 }
+/**
+ * @deprecated Use `import { getEmojiVariation } from '@atlaskit/emoji/emoji-repository'` instead.
+ */
+export { getEmojiVariation } from './getEmojiVariation';

package/dist/types/api/EmojiResource.d.ts

@@ -2,8 +2,8 @@ import { AbstractResource, type OnProviderChange, type ServiceConfig } from '@at
 import type { CategoryId } from '../components/picker/categories';
 import { type EmojiDescription, type EmojiId, type EmojiProvider, type EmojiResponse, type EmojiSearchResult, type EmojiUpload, type OptionalEmojiDescription, type OptionalEmojiDescriptionWithVariations, type OptionalUser, type SearchOptions, type ToneSelection, type UploadingEmojiProvider, type User } from '../types';
 import EmojiRepository from './EmojiRepository';
-import SiteEmojiResource from './media/SiteEmojiResource';
 import type { OptimisticImageApiLoaderConfig, Options, SingleEmojiApiLoaderConfig, EmojiLoadSuccessCallback, EmojiLoadFailCallback } from './EmojiUtils';
+import SiteEmojiResource from './media/SiteEmojiResource';
 interface GetEmojiProviderOptions {
     /**
      * Whether fetch emoji provider at start
@@ -70,14 +70,6 @@ export interface ResolveReject<T> {
     reject(reason?: any): void;
     resolve(result: T): void;
 }
-/**
- * Checks if the emojiProvider can support uploading at a feature level.
- *
- * Follow this up with an isUploadSupported() check to see if the provider is actually
- * configured to support uploads.
- * https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates
- */
-export declare const supportsUploadFeature: (emojiProvider: EmojiProvider) => emojiProvider is UploadingEmojiProvider;
 export interface LastQuery {
     options?: SearchOptions;
     query?: string;
@@ -158,3 +150,7 @@ export default class UploadingEmojiResource extends EmojiResource implements Upl
     uploadCustomEmoji(upload: EmojiUpload, retry?: boolean, timeout?: number): Promise<EmojiDescription>;
     prepareForUpload(): Promise<void>;
 }
+/**
+ * @deprecated Use `import { supportsUploadFeature } from '@atlaskit/emoji/emoji-resource'` instead.
+ */
+export { supportsUploadFeature } from './supportsUploadFeature';

package/dist/types/api/EmojiUtils.d.ts

@@ -1,5 +1,5 @@
-import { type RequestServiceOptions, type ServiceConfig } from '@atlaskit/util-service-support';
-import { type AltRepresentations, type EmojiDescription, type EmojiDescriptionWithVariations, type EmojiMeta, type EmojiRepresentation, type EmojiResponse, type EmojiServiceDescriptionWithVariations, type EmojiServiceRepresentation, type EmojiServiceResponse, type EmojiId } from '../types';
+import { type ServiceConfig } from '@atlaskit/util-service-support';
+import { type EmojiId } from '../types';
 export interface EmojiLoaderConfig extends ServiceConfig {
     getRatio?: () => number;
 }
@@ -14,16 +14,47 @@ export interface OptimisticImageApiLoaderConfig extends Omit<ServiceConfig, 'url
 }
 export type EmojiLoadSuccessCallback = (emojiId?: string) => void;
 export type EmojiLoadFailCallback = (emojiId?: string, reason?: string) => void;
-export declare const emojiRequest: (provider: EmojiLoaderConfig, options?: RequestServiceOptions) => Promise<EmojiServiceResponse>;
-export declare const getPixelRatio: () => number;
-export declare const getAltRepresentation: (reps: AltRepresentations) => EmojiServiceRepresentation;
-export declare const isMediaApiUrl: (url: string, meta?: EmojiMeta) => boolean;
-export declare const denormaliseServiceRepresentation: (representation: EmojiServiceRepresentation, meta?: EmojiMeta) => EmojiRepresentation;
-export declare const denormaliseServiceAltRepresentation: (altReps?: AltRepresentations, meta?: EmojiMeta) => EmojiRepresentation;
-export declare const denormaliseSkinEmoji: (emoji: EmojiServiceDescriptionWithVariations, meta?: EmojiMeta) => EmojiDescriptionWithVariations[];
-/**
- * Denormalised an emoji response (emojis + sprite references) into an array of
- * emoji with local sprite definitions.
- */
-export declare const denormaliseEmojiServiceResponse: (emojiData: EmojiServiceResponse) => EmojiResponse;
-export declare const shouldUseAltRepresentation: (emoji: EmojiDescription, fitToHeight?: number) => boolean;
+/**
+ * @deprecated Use `import { emojiRequest } from '@atlaskit/emoji/emoji-utils'` instead.
+ */
+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/types/api/calculateScale.d.ts

@@ -0,0 +1,2 @@
+import { type KeyValues } from '@atlaskit/util-service-support';
+export declare const calculateScale: (getRatio: () => number) => KeyValues;

package/dist/types/api/denormaliseEmojiServiceResponse.d.ts

@@ -0,0 +1,6 @@
+import { type EmojiResponse, type EmojiServiceResponse } from '../types';
+/**
+ * Denormalised an emoji response (emojis + sprite references) into an array of
+ * emoji with local sprite definitions.
+ */
+export declare const denormaliseEmojiServiceResponse: (emojiData: EmojiServiceResponse) => EmojiResponse;

package/dist/types/api/denormaliseServiceAltRepresentation.d.ts

@@ -0,0 +1,2 @@
+import { type AltRepresentations, type EmojiMeta, type EmojiRepresentation } from '../types';
+export declare const denormaliseServiceAltRepresentation: (altReps?: AltRepresentations, meta?: EmojiMeta) => EmojiRepresentation;

package/dist/types/api/denormaliseServiceRepresentation.d.ts

@@ -0,0 +1,2 @@
+import { type EmojiMeta, type EmojiRepresentation, type EmojiServiceRepresentation } from '../types';
+export declare const denormaliseServiceRepresentation: (representation: EmojiServiceRepresentation, meta?: EmojiMeta) => EmojiRepresentation;

package/dist/types/api/denormaliseSkinEmoji.d.ts

@@ -0,0 +1,2 @@
+import { type EmojiDescriptionWithVariations, type EmojiMeta, type EmojiServiceDescriptionWithVariations } from '../types';
+export declare const denormaliseSkinEmoji: (emoji: EmojiServiceDescriptionWithVariations, meta?: EmojiMeta) => EmojiDescriptionWithVariations[];

package/dist/types/api/denormaliseStandardRepresentation.d.ts

@@ -0,0 +1,2 @@
+import { type EmojiMeta, type EmojiRepresentation, type EmojiServiceDescription } from '../types';
+export declare const denormaliseStandardRepresentation: (emoji: EmojiServiceDescription, meta?: EmojiMeta) => EmojiRepresentation;

package/dist/types/api/emojiRequest.d.ts

@@ -0,0 +1,4 @@
+import { type RequestServiceOptions } from '@atlaskit/util-service-support';
+import { type EmojiServiceResponse } from '../types';
+import type { EmojiLoaderConfig } from './EmojiUtils';
+export declare const emojiRequest: (provider: EmojiLoaderConfig, options?: RequestServiceOptions) => Promise<EmojiServiceResponse>;

package/dist/types/api/getAltRepresentation.d.ts

@@ -0,0 +1,2 @@
+import { type AltRepresentations, type EmojiServiceRepresentation } from '../types';
+export declare const getAltRepresentation: (reps: AltRepresentations) => EmojiServiceRepresentation;

package/dist/types/api/getEmojiVariation.d.ts

@@ -0,0 +1,2 @@
+import { type EmojiDescription, type SearchOptions } from '../types';
+export declare const getEmojiVariation: (emoji: EmojiDescription, options?: SearchOptions) => EmojiDescription;

package/dist/types/api/getPixelRatio.d.ts

@@ -0,0 +1 @@
+export declare const getPixelRatio: () => number;

package/dist/types/api/internal/AlphabeticalShortnameComparator.d.ts

@@ -0,0 +1,8 @@
+import type { EmojiDescription } from '../../types';
+import type { EmojiComparator } from './Comparators';
+export declare class AlphabeticalShortnameComparator implements EmojiComparator {
+    private static INSTANCE;
+    private constructor();
+    static get Instance(): AlphabeticalShortnameComparator;
+    compare(e1: EmojiDescription, e2: EmojiDescription): number;
+}

package/dist/types/api/internal/AsciiMatchComparator.d.ts

@@ -0,0 +1,11 @@
+import type { EmojiDescription } from '../../types';
+import type { EmojiComparator } from './Comparators';
+/**
+ * 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 declare class AsciiMatchComparator implements EmojiComparator {
+    private query;
+    constructor(query: string);
+    compare(e1: EmojiDescription, e2: EmojiDescription): 0 | 1 | -1;
+}

package/dist/types/api/internal/ChainedEmojiComparator.d.ts

@@ -0,0 +1,14 @@
+import type { EmojiDescription } from '../../types';
+import type { EmojiComparator } from './Comparators';
+/**
+ * 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 declare class ChainedEmojiComparator implements EmojiComparator {
+    private chain;
+    constructor(...comparators: EmojiComparator[]);
+    compare(e1: EmojiDescription, e2: EmojiDescription): number;
+}

package/dist/types/api/internal/Comparators.d.ts

@@ -1,13 +1,4 @@
 import type { EmojiDescription } from '../../types';
-/**
- * Create the default sort comparator to be used for the user queries against emoji
- *
- * @param query the query used in the search to be sorted. Any colons will be stripped from the query and it will be
- * converted to lowercase.
- * @param orderedIds the id of emoji ordered by how frequently they are used
- */
-export declare function createSearchEmojiComparator(query?: string, orderedIds?: Array<string>): EmojiComparator;
-export declare function createUsageOnlyEmojiComparator(orderedIds: Array<string>): EmojiComparator;
 /**
  * Returns a number representing the result of comparing e1 and e2.
  * Compatible with Array.sort, which is to say -
@@ -18,92 +9,3 @@ export declare function createUsageOnlyEmojiComparator(orderedIds: Array<string>
 export interface EmojiComparator {
     compare(e1: EmojiDescription, e2: EmojiDescription): number;
 }
-/**
- * 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 declare class ChainedEmojiComparator implements EmojiComparator {
-    private chain;
-    constructor(...comparators: EmojiComparator[]);
-    compare(e1: EmojiDescription, e2: EmojiDescription): number;
-}
-/**
- * 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 declare class AsciiMatchComparator implements EmojiComparator {
-    private query;
-    constructor(query: string);
-    compare(e1: EmojiDescription, e2: EmojiDescription): 0 | 1 | -1;
-}
-/**
- * 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 declare class ExactShortNameMatchComparator implements EmojiComparator {
-    private colonQuery;
-    private typeComparator;
-    constructor(query: string);
-    compare(e1: EmojiDescription, e2: EmojiDescription): number;
-}
-/**
- * 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 declare class EmojiTypeComparator implements EmojiComparator {
-    private typeToNumber;
-    constructor(reverse?: boolean);
-    compare(e1: EmojiDescription, e2: EmojiDescription): number;
-    private emojiTypeToOrdinal;
-}
-/**
- * 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 declare class UsageFrequencyComparator implements EmojiComparator {
-    private positionLookup;
-    constructor(orderedIds: Array<string>);
-    compare(e1: EmojiDescription, e2: EmojiDescription): number;
-    /**
-     * Get the ordinal representing the position of this emoji.
-     *
-     * @param id the id of the emoji
-     */
-    private getPositionInOrder;
-}
-type KeysOfType<T, TProp> = {
-    [P in keyof T]: T[P] extends TProp | undefined ? P : never;
-}[keyof T];
-/**
- * A comparator that will sort higher an emoji which matches the query string earliest in the indicated
- * property.
- */
-export declare class QueryStringPositionMatchComparator implements EmojiComparator {
-    private readonly propertyName;
-    private query;
-    /**
-     * @param query the query to match
-     * @param propertyToCompare the property of EmojiDescription to check for query within
-     */
-    constructor(query: string, propertyToCompare: KeysOfType<EmojiDescription, string>);
-    private getScore;
-    compare(e1: EmojiDescription, e2: EmojiDescription): number;
-}
-export declare class OrderComparator implements EmojiComparator {
-    private static INSTANCE;
-    private constructor();
-    static get Instance(): OrderComparator;
-    compare(e1: EmojiDescription, e2: EmojiDescription): number;
-}
-export declare class AlphabeticalShortnameComparator implements EmojiComparator {
-    private static INSTANCE;
-    private constructor();
-    static get Instance(): AlphabeticalShortnameComparator;
-    compare(e1: EmojiDescription, e2: EmojiDescription): number;
-}
-export {};

package/dist/types/api/internal/EmojiTypeComparator.d.ts

@@ -0,0 +1,14 @@
+import type { EmojiDescription } from '../../types';
+import type { EmojiComparator } from './Comparators';
+/**
+ * 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 declare class EmojiTypeComparator implements EmojiComparator {
+    private typeToNumber;
+    constructor(reverse?: boolean);
+    compare(e1: EmojiDescription, e2: EmojiDescription): number;
+    private emojiTypeToOrdinal;
+}

package/dist/types/api/internal/ExactShortNameMatchComparator.d.ts

@@ -0,0 +1,12 @@
+import type { EmojiDescription } from '../../types';
+import type { EmojiComparator } from './Comparators';
+/**
+ * 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 declare class ExactShortNameMatchComparator implements EmojiComparator {
+    private colonQuery;
+    private typeComparator;
+    constructor(query: string);
+    compare(e1: EmojiDescription, e2: EmojiDescription): number;
+}

package/dist/types/api/internal/Gateway.d.ts

@@ -0,0 +1,13 @@
+export declare class Gateway {
+    private maximumPermitted;
+    private count;
+    constructor(maximumPermitted: number);
+    /**
+     * 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.
+     */
+    submit(f: () => void): boolean;
+    private completed;
+}

package/dist/types/api/internal/OrderComparator.d.ts

@@ -0,0 +1,8 @@
+import type { EmojiDescription } from '../../types';
+import type { EmojiComparator } from './Comparators';
+export declare class OrderComparator implements EmojiComparator {
+    private static INSTANCE;
+    private constructor();
+    static get Instance(): OrderComparator;
+    compare(e1: EmojiDescription, e2: EmojiDescription): number;
+}

package/dist/types/api/internal/QueryStringPositionMatchComparator.d.ts

@@ -0,0 +1,21 @@
+import type { EmojiDescription } from '../../types';
+import type { EmojiComparator } from './Comparators';
+type KeysOfType<T, TProp> = {
+    [P in keyof T]: T[P] extends TProp | undefined ? P : never;
+}[keyof T];
+/**
+ * A comparator that will sort higher an emoji which matches the query string earliest in the indicated
+ * property.
+ */
+export declare class QueryStringPositionMatchComparator implements EmojiComparator {
+    private readonly propertyName;
+    private query;
+    /**
+     * @param query the query to match
+     * @param propertyToCompare the property of EmojiDescription to check for query within
+     */
+    constructor(query: string, propertyToCompare: KeysOfType<EmojiDescription, string>);
+    private getScore;
+    compare(e1: EmojiDescription, e2: EmojiDescription): number;
+}
+export {};