@atlaskit/emoji 67.4.1 → 67.4.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/emoji
 
+## 67.4.2
+
+### Patch Changes
+
+- [`cccd619ffc5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cccd619ffc5) - fix focus style for category selector
+
 ## 67.4.1
 
 ### Patch Changes

package/dist/cjs/components/picker/styles.js

@@ -46,7 +46,7 @@ var categorySelector = (0, _react.css)({
 });
 exports.categorySelector = categorySelector;
 var categorySelectorTablist = (0, _react.css)({
-  padding: '6px 8px',
+  padding: "var(--ds-space-075, 6px)".concat(" ", "var(--ds-space-100, 8px)"),
   display: 'flex',
   flexDirection: 'row',
   justifyContent: 'space-around',
@@ -72,14 +72,14 @@ var categoryStyles = (0, _react.css)((_css3 = {
   borderRadius: "var(--ds-radius-100, 3px)",
   color: "var(--ds-text-subtlest, ".concat(_colors.N100A, ")"),
   cursor: 'pointer',
-  padding: 0,
+  padding: "var(--ds-space-0, 0px)",
   transition: 'color 0.2s ease'
 }, (0, _defineProperty2.default)(_css3, '&::-moz-focus-inner', {
   border: '0 none',
-  padding: 0
+  padding: "var(--ds-space-0, 0px)"
 }), (0, _defineProperty2.default)(_css3, '&:hover', {
   color: "var(--ds-text-selected, ".concat(_colors.B200, ")")
-}), (0, _defineProperty2.default)(_css3, '&:focus', {
+}), (0, _defineProperty2.default)(_css3, '&:focus-visible', {
   boxShadow: "0 0 0 2px ".concat("var(--ds-border-focused, ".concat(_colors.B100, ")")),
   transitionDuration: '0s, 0.2s',
   outline: 'none'
@@ -103,7 +103,7 @@ var virtualList = (0, _react.css)({
   '&:focus': {
     outline: 'none'
   },
-  paddingBottom: '8px'
+  paddingBottom: "var(--ds-space-100, 8px)"
 });
 
 //// Search
@@ -118,7 +118,7 @@ var input = (0, _react.css)((_css4 = {
   cursor: 'inherit',
   fontSize: '14px',
   outline: 'none',
-  padding: '1px 0 2px 6px',
+  padding: "1px ".concat("var(--ds-space-0, 0px)", " ", "var(--ds-space-025, 2px)", " ", "var(--ds-space-075, 6px)"),
   width: '100%'
 }, (0, _defineProperty2.default)(_css4, '&:invalid', {
   boxShadow: 'none'
@@ -148,14 +148,14 @@ var emojiPickerSpinner = (0, _react.css)({
 //// Category/Result
 exports.emojiPickerSpinner = emojiPickerSpinner;
 var emojiPickerRow = (0, _react.css)({
-  marginLeft: '8px'
+  marginLeft: "var(--ds-space-100, 8px)"
 });
 exports.emojiPickerRow = emojiPickerRow;
 var emojiCategoryTitle = (0, _react.css)({
   boxSizing: 'border-box',
   color: "var(--ds-text, ".concat(_colors.N900, ")"),
   fontSize: '14px',
-  padding: '5px 8px',
+  padding: "5px ".concat("var(--ds-space-100, 8px)"),
   textTransform: 'lowercase',
   '&:first-letter': {
     textTransform: 'uppercase'
@@ -168,17 +168,17 @@ var emojiItem = (0, _react.css)((_css5 = {
   width: '40px'
 }, (0, _defineProperty2.default)(_css5, "& .".concat(_styles.emojiNodeStyles), {
   cursor: 'pointer',
-  padding: '8px',
+  padding: "var(--ds-space-100, 8px)",
   borderRadius: '5px',
   width: '24px',
   height: '24px'
 }), (0, _defineProperty2.default)(_css5, "& .".concat(_styles.placeholder), {
-  padding: '0',
+  padding: "var(--ds-space-0, 0px)",
   margin: '7px',
   minWidth: '24px',
   maxWidth: '24px'
 }), (0, _defineProperty2.default)(_css5, "& .".concat(_styles.emojiNodeStyles, " .").concat(_styles.placeholder), {
-  margin: '0'
+  margin: "var(--ds-space-0, 0px)"
 }), (0, _defineProperty2.default)(_css5, "& .".concat(_styles.emojiNodeStyles, " > img"), {
   position: 'relative',
   left: '50%',

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/emoji",
-	"version": "67.4.1",
+	"version": "67.4.2",
 	"sideEffects": false
 }

package/dist/es2019/components/picker/styles.js

@@ -36,7 +36,7 @@ export const categorySelector = css({
 });
 
 export const categorySelectorTablist = css({
-  padding: '6px 8px',
+  padding: `${"var(--ds-space-075, 6px)"} ${"var(--ds-space-100, 8px)"}`,
   display: 'flex',
   flexDirection: 'row',
   justifyContent: 'space-around',
@@ -61,17 +61,17 @@ export const categoryStyles = css({
   borderRadius: "var(--ds-radius-100, 3px)",
   color: `var(--ds-text-subtlest, ${N100A})`,
   cursor: 'pointer',
-  padding: 0,
+  padding: "var(--ds-space-0, 0px)",
   transition: 'color 0.2s ease',
   /* Firefox */
   ['&::-moz-focus-inner']: {
     border: '0 none',
-    padding: 0
+    padding: "var(--ds-space-0, 0px)"
   },
   ['&:hover']: {
     color: `var(--ds-text-selected, ${B200})`
   },
-  '&:focus': {
+  '&:focus-visible': {
     boxShadow: `0 0 0 2px ${`var(--ds-border-focused, ${B100})`}`,
     transitionDuration: '0s, 0.2s',
     outline: 'none'
@@ -95,7 +95,7 @@ export const virtualList = css({
   '&:focus': {
     outline: 'none'
   },
-  paddingBottom: '8px'
+  paddingBottom: "var(--ds-space-100, 8px)"
 });
 
 //// Search
@@ -109,7 +109,7 @@ export const input = css({
   cursor: 'inherit',
   fontSize: '14px',
   outline: 'none',
-  padding: '1px 0 2px 6px',
+  padding: `1px ${"var(--ds-space-0, 0px)"} ${"var(--ds-space-025, 2px)"} ${"var(--ds-space-075, 6px)"}`,
   width: '100%',
   ['&:invalid']: {
     boxShadow: 'none'
@@ -140,13 +140,13 @@ export const emojiPickerSpinner = css({
 //// Category/Result
 
 export const emojiPickerRow = css({
-  marginLeft: '8px'
+  marginLeft: "var(--ds-space-100, 8px)"
 });
 export const emojiCategoryTitle = css({
   boxSizing: 'border-box',
   color: `var(--ds-text, ${N900})`,
   fontSize: '14px',
-  padding: '5px 8px',
+  padding: `5px ${"var(--ds-space-100, 8px)"}`,
   textTransform: 'lowercase',
   '&:first-letter': {
     textTransform: 'uppercase'
@@ -158,19 +158,19 @@ export const emojiItem = css({
   width: '40px',
   [`& .${emojiNodeStyles}`]: {
     cursor: 'pointer',
-    padding: '8px',
+    padding: "var(--ds-space-100, 8px)",
     borderRadius: '5px',
     width: '24px',
     height: '24px'
   },
   [`& .${placeholder}`]: {
-    padding: '0',
+    padding: "var(--ds-space-0, 0px)",
     margin: '7px',
     minWidth: '24px',
     maxWidth: '24px'
   },
   [`& .${emojiNodeStyles} .${placeholder}`]: {
-    margin: '0'
+    margin: "var(--ds-space-0, 0px)"
   },
   // Fit non-square emoji to square
   [`& .${emojiNodeStyles} > img`]: {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/emoji",
-	"version": "67.4.1",
+	"version": "67.4.2",
 	"sideEffects": false
 }

package/dist/esm/components/picker/styles.js

@@ -39,7 +39,7 @@ export var categorySelector = css({
 });
 
 export var categorySelectorTablist = css({
-  padding: '6px 8px',
+  padding: "var(--ds-space-075, 6px)".concat(" ", "var(--ds-space-100, 8px)"),
   display: 'flex',
   flexDirection: 'row',
   justifyContent: 'space-around',
@@ -62,14 +62,14 @@ export var categoryStyles = css((_css3 = {
   borderRadius: "var(--ds-radius-100, 3px)",
   color: "var(--ds-text-subtlest, ".concat(N100A, ")"),
   cursor: 'pointer',
-  padding: 0,
+  padding: "var(--ds-space-0, 0px)",
   transition: 'color 0.2s ease'
 }, _defineProperty(_css3, '&::-moz-focus-inner', {
   border: '0 none',
-  padding: 0
+  padding: "var(--ds-space-0, 0px)"
 }), _defineProperty(_css3, '&:hover', {
   color: "var(--ds-text-selected, ".concat(B200, ")")
-}), _defineProperty(_css3, '&:focus', {
+}), _defineProperty(_css3, '&:focus-visible', {
   boxShadow: "0 0 0 2px ".concat("var(--ds-border-focused, ".concat(B100, ")")),
   transitionDuration: '0s, 0.2s',
   outline: 'none'
@@ -92,7 +92,7 @@ export var virtualList = css({
   '&:focus': {
     outline: 'none'
   },
-  paddingBottom: '8px'
+  paddingBottom: "var(--ds-space-100, 8px)"
 });
 
 //// Search
@@ -106,7 +106,7 @@ export var input = css((_css4 = {
   cursor: 'inherit',
   fontSize: '14px',
   outline: 'none',
-  padding: '1px 0 2px 6px',
+  padding: "1px ".concat("var(--ds-space-0, 0px)", " ", "var(--ds-space-025, 2px)", " ", "var(--ds-space-075, 6px)"),
   width: '100%'
 }, _defineProperty(_css4, '&:invalid', {
   boxShadow: 'none'
@@ -135,13 +135,13 @@ export var emojiPickerSpinner = css({
 //// Category/Result
 
 export var emojiPickerRow = css({
-  marginLeft: '8px'
+  marginLeft: "var(--ds-space-100, 8px)"
 });
 export var emojiCategoryTitle = css({
   boxSizing: 'border-box',
   color: "var(--ds-text, ".concat(N900, ")"),
   fontSize: '14px',
-  padding: '5px 8px',
+  padding: "5px ".concat("var(--ds-space-100, 8px)"),
   textTransform: 'lowercase',
   '&:first-letter': {
     textTransform: 'uppercase'
@@ -153,17 +153,17 @@ export var emojiItem = css((_css5 = {
   width: '40px'
 }, _defineProperty(_css5, "& .".concat(emojiNodeStyles), {
   cursor: 'pointer',
-  padding: '8px',
+  padding: "var(--ds-space-100, 8px)",
   borderRadius: '5px',
   width: '24px',
   height: '24px'
 }), _defineProperty(_css5, "& .".concat(placeholder), {
-  padding: '0',
+  padding: "var(--ds-space-0, 0px)",
   margin: '7px',
   minWidth: '24px',
   maxWidth: '24px'
 }), _defineProperty(_css5, "& .".concat(emojiNodeStyles, " .").concat(placeholder), {
-  margin: '0'
+  margin: "var(--ds-space-0, 0px)"
 }), _defineProperty(_css5, "& .".concat(emojiNodeStyles, " > img"), {
   position: 'relative',
   left: '50%',

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/emoji",
-	"version": "67.4.1",
+	"version": "67.4.2",
 	"sideEffects": false
 }

package/dist/types-ts4.5/admin.d.ts

@@ -0,0 +1 @@
+export { default as EmojiUploader } from './components/uploader/EmojiUploader';

package/dist/types-ts4.5/api/EmojiLoader.d.ts

@@ -0,0 +1,13 @@
+import { EmojiResponse } from '../types';
+import { EmojiLoaderConfig } from './EmojiUtils';
+/**
+ * Emoji providers should return JSON in the format defined by EmojiServiceResponse.
+ */
+export default class EmojiLoader {
+    private config;
+    constructor(config: EmojiLoaderConfig);
+    /**
+     * Returns a promise with an array of Emoji from all providers.
+     */
+    loadEmoji(): Promise<EmojiResponse>;
+}

package/dist/types-ts4.5/api/EmojiRepository.d.ts

@@ -0,0 +1,72 @@
+import { CategoryId } from '../components/picker/categories';
+import { EmojiDescription, EmojiSearchResult, OptionalEmojiDescription, 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;
+    private shortNameMap;
+    private idMap;
+    private asciiMap;
+    private dynamicCategoryList;
+    private static readonly defaultEmojiWeight;
+    protected usageTracker: UsageFrequencyTracker;
+    constructor(emojis: EmojiDescription[], usageTracker?: UsageFrequencyTracker);
+    /**
+     * Returns all available (and searchable) emoji in some default order.
+     */
+    all(): EmojiSearchResult;
+    /**
+     * Text search of emoji shortName and name field for suitable matches.
+     *
+     * Returns an array of all (searchable) emoji if query is empty or null, otherwise returns matching emoji.
+     *
+     * You can change how the results are sorted by specifying a custom EmojiComparator in the SearchOptions. If
+     * you don't want any sorting you can also disable via the SearchOptions (this might be a useful optimisation).
+     * If no sort is specified in SearchOptions then a default sorting it applied based on the query.
+     */
+    search(query?: string, options?: SearchOptions): EmojiSearchResult;
+    /**
+     * Returns all emoji with matching shortName
+     */
+    findAllMatchingShortName(shortName: string): EmojiDescription[];
+    /**
+     * Returns the first matching emoji matching the shortName, or null if none found.
+     */
+    findByShortName(shortName: string): OptionalEmojiDescription;
+    /**
+     * Returns the first matching emoji matching the id, or null if none found.
+     */
+    findById(id: string): OptionalEmojiDescription;
+    findByAsciiRepresentation(asciiEmoji: string): OptionalEmojiDescription;
+    findInCategory(categoryId: CategoryId): EmojiDescription[];
+    addUnknownEmoji(emoji: EmojiDescription): void;
+    getAsciiMap(): Map<string, EmojiDescription>;
+    /**
+     * Return the most frequently used emoji, ordered from most frequent to least frequent. Return an empty array if
+     * there are none.
+     *
+     * @param options optional settings to be applied to the set of frequently used emoji
+     */
+    getFrequentlyUsed(options?: SearchOptions): EmojiDescription[];
+    getDynamicCategoryList(): CategoryId[];
+    /**
+     * Call this on emoji usage to allow the EmojiRepository to track the usage of emoji (which could be useful
+     * in sorting, etc).
+     *
+     * @param emoji the emoji that was just used
+     */
+    used(emoji: EmojiDescription): void;
+    delete(emoji: EmojiDescription): void;
+    private withAsciiMatch;
+    private applySearchOptions;
+    private initMembers;
+    /**
+     * Optimisation to initialise all map member variables in single loop over emojis
+     */
+    private initRepositoryMetadata;
+    private initSearchIndex;
+    private getAllSearchableEmojis;
+    private addToMaps;
+    private addToDynamicCategories;
+}

package/dist/types-ts4.5/api/EmojiRepositoryRegex.d.ts

@@ -0,0 +1 @@
+export declare const tokenizerRegex: RegExp;

package/dist/types-ts4.5/api/EmojiResource.d.ts

@@ -0,0 +1,139 @@
+import { AbstractResource, OnProviderChange, ServiceConfig } from '@atlaskit/util-service-support';
+import { CategoryId } from '../components/picker/categories';
+import { EmojiDescription, EmojiId, EmojiProvider, EmojiResponse, EmojiSearchResult, EmojiUpload, OptionalEmojiDescription, OptionalEmojiDescriptionWithVariations, OptionalUser, SearchOptions, ToneSelection, UploadingEmojiProvider, User } from '../types';
+import EmojiRepository from './EmojiRepository';
+import SiteEmojiResource from './media/SiteEmojiResource';
+import { OptimisticImageApiLoaderConfig, SingleEmojiApiLoaderConfig } from './EmojiUtils';
+interface GetEmojiProviderOptions {
+    /**
+     * Whether fetch emoji provider at start
+     * @defaultValue true
+     */
+    fetchAtStart?: boolean;
+}
+export type { EmojiProvider, UploadingEmojiProvider } from '../types';
+export interface EmojiResourceConfig {
+    /**
+     * The service configuration for remotely recording emoji selections.
+     * A post will be performed to this URL with the EmojiId as the body.
+     */
+    recordConfig?: ServiceConfig;
+    /**
+     * This defines the different providers. Later providers will override earlier
+     * providers when performing shortName based look up.
+     */
+    providers: ServiceConfig[];
+    /**
+     * Must be set to true to enable upload support in the emoji components.
+     *
+     * Can be used for the restriction of the upload UI based on permissions, or feature flags.
+     *
+     * Note this also requires that other conditions are met (for example, one of the providers
+     * must support upload for the UploadingEmojiResource implementation of UploadingEmojiProvider).
+     */
+    allowUpload?: boolean;
+    /**
+     * Logged user in the Product.
+     */
+    currentUser?: User;
+    /**
+     * This is specifically used for fetching a meta information of a single emoji.
+     * Useful for when rendering a single or a subset of emojis on a page that does not require the
+     * whole provider list to be downloaded.
+     */
+    singleEmojiApi?: SingleEmojiApiLoaderConfig;
+    /**
+     * Renders an image while the provider is being downloaded to reduce the time
+     * the user is being presented with a placeholder
+     */
+    optimisticImageApi?: OptimisticImageApiLoaderConfig;
+}
+export interface OnEmojiProviderChange extends OnProviderChange<EmojiSearchResult, any, void> {
+}
+export interface Retry<T> {
+    (): Promise<T> | T;
+}
+export interface ResolveReject<T> {
+    resolve(result: T): void;
+    reject(reason?: any): 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 {
+    query?: string;
+    options?: SearchOptions;
+}
+export declare class EmojiResource extends AbstractResource<string, EmojiSearchResult, any, undefined, SearchOptions> implements EmojiProvider {
+    protected recordConfig?: ServiceConfig;
+    protected emojiRepository?: EmojiRepository;
+    protected lastQuery?: LastQuery;
+    protected activeLoaders: number;
+    protected initialLoaders: number;
+    protected retries: Map<Retry<any>, ResolveReject<any>>;
+    protected siteEmojiResource?: SiteEmojiResource;
+    protected selectedTone: ToneSelection;
+    protected currentUser?: User;
+    protected isInitialised: boolean;
+    protected emojiResponses: EmojiResponse[];
+    emojiProviderConfig: EmojiResourceConfig;
+    constructor(config: EmojiResourceConfig);
+    /**
+     * Get the emoji provider from Emoji Resource
+     * @returns Promise<EmojiProvider>
+     */
+    getEmojiProvider(options?: GetEmojiProviderOptions): Promise<EmojiProvider>;
+    private fetchIndividualProvider;
+    fetchEmojiProvider(force?: boolean): Promise<EmojiRepository | undefined>;
+    fetchByEmojiId(emojiId: EmojiId, optimistic: boolean): Promise<OptionalEmojiDescriptionWithVariations>;
+    private getProviderType;
+    protected initEmojiRepository(emojiResponses: EmojiResponse[]): void;
+    protected initSiteEmojiResource(emojiResponse: EmojiResponse, provider: ServiceConfig): Promise<void>;
+    private performRetries;
+    getOptimisticImageURL: (emojiId: EmojiId) => string | undefined;
+    protected isRepositoryAvailable: <T>(repository?: T | undefined) => repository is T;
+    private isLoaded;
+    private loadStoredTone;
+    protected refreshLastFilter(): void;
+    protected retryIfLoading<T>(retry: Retry<T>, defaultResponse: T): Promise<T>;
+    protected notifyResult(result: EmojiSearchResult): void;
+    /**
+     *  Returns the EmojiDescription with a valid media path that includes query token and client attributes to access the emoji media inline.
+     */
+    getMediaEmojiDescriptionURLWithInlineToken(emoji: EmojiDescription): Promise<EmojiDescription>;
+    loadMediaEmoji(emoji: EmojiDescription, useAlt?: boolean): OptionalEmojiDescription | Promise<OptionalEmojiDescription>;
+    optimisticMediaRendering(emoji: EmojiDescription, useAlt?: boolean): boolean;
+    filter(query?: string, options?: SearchOptions): void;
+    findByShortName(shortName: string): OptionalEmojiDescription | Promise<OptionalEmojiDescription>;
+    findByEmojiId(emojiId: EmojiId): OptionalEmojiDescription | Promise<OptionalEmojiDescription>;
+    findById(id: string): OptionalEmojiDescription | Promise<OptionalEmojiDescription>;
+    findInCategory(categoryId: CategoryId): Promise<EmojiDescription[]>;
+    getAsciiMap(): Promise<Map<string, EmojiDescription>>;
+    getFrequentlyUsed(options?: SearchOptions): Promise<EmojiDescription[]>;
+    /**
+     * Record the selection of an emoji to a remote service if 'recordConfig' has been supplied.
+     * Regardless of the recordConfig, emoji selections will always be recorded on the EmojiRepository
+     * for the purposes of tracking the frequency of use.
+     *
+     * @param emoji The full description of the emoji to record usage for.
+     */
+    recordSelection(emoji: EmojiDescription): Promise<any>;
+    deleteSiteEmoji(emoji: EmojiDescription): Promise<boolean>;
+    getSelectedTone(): ToneSelection;
+    setSelectedTone(tone: ToneSelection): void;
+    calculateDynamicCategories(): Promise<CategoryId[]>;
+    getCurrentUser(): OptionalUser;
+    protected addUnknownEmoji(emoji: EmojiDescription): void;
+}
+export default class UploadingEmojiResource extends EmojiResource implements UploadingEmojiProvider {
+    protected allowUpload: boolean;
+    constructor(config: EmojiResourceConfig);
+    isUploadSupported(): Promise<boolean>;
+    uploadCustomEmoji(upload: EmojiUpload, retry?: boolean): Promise<EmojiDescription>;
+    prepareForUpload(): Promise<void>;
+}

package/dist/types-ts4.5/api/EmojiUtils.d.ts

@@ -0,0 +1,24 @@
+import { RequestServiceOptions, ServiceConfig } from '@atlaskit/util-service-support';
+import { AltRepresentations, EmojiDescription, EmojiDescriptionWithVariations, EmojiMeta, EmojiRepresentation, EmojiResponse, EmojiServiceDescriptionWithVariations, EmojiServiceRepresentation, EmojiServiceResponse, EmojiId } from '../types';
+export interface EmojiLoaderConfig extends ServiceConfig {
+    getRatio?: () => number;
+}
+export interface SingleEmojiApiLoaderConfig extends Omit<ServiceConfig, 'url'> {
+    getUrl: (emojiId: EmojiId) => string;
+}
+export interface OptimisticImageApiLoaderConfig extends Omit<ServiceConfig, 'url'> {
+    getUrl: (emojiId: EmojiId) => string;
+}
+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;

package/dist/types-ts4.5/api/internal/Comparators.d.ts

@@ -0,0 +1,109 @@
+import { 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 -
+ *   - less than 0 if e1 should come first
+ *   - 0 if they are equal; e1 and e2 will be unchanged in position relative to each other
+ *   - greater than 0 if e2 should come first.
+ */
+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 {};