@atlaskit/emoji 67.4.1 → 67.4.3

package/dist/types-ts4.5/util/analytics/useSampledUFOComponentExperience.d.ts

@@ -0,0 +1,8 @@
+import { CustomData, UFOExperience } from '@atlaskit/ufo';
+/**
+ * A hook to start an experience and to auto abort the experience when the parent component is unmounted.
+ * Use this instead of a direct call to `experience.start`. If you need to restart the experience
+ * simply trigger an unmount and remount of the parent component.
+ * @param experience the experience to start and abort
+ */
+export declare const useSampledUFOComponentExperience: (experience: UFOExperience, samplingRate: number, metadata?: CustomData) => null;

package/dist/types-ts4.5/util/browser-support.d.ts

@@ -0,0 +1,6 @@
+type BrowserSupport = {
+    mac: boolean;
+    supportsIntersectionObserver: boolean;
+};
+declare const result: BrowserSupport;
+export default result;

package/dist/types-ts4.5/util/constants.d.ts

@@ -0,0 +1,60 @@
+import { CategoryId } from '../components/picker/categories';
+export declare const customCategory = "CUSTOM";
+export declare const frequentCategory = "FREQUENT";
+export declare const customType = "SITE";
+export declare const searchCategory = "SEARCH";
+export declare const yourUploadsCategory = "USER_CUSTOM";
+export declare const customTitle = "allUploadsCustomCategory";
+export declare const userCustomTitle = "userUploadsCustomCategory";
+export declare const dataURLPrefix = "data:";
+export declare const deleteEmojiLabel = "delete-emoji";
+/**
+ * A constant used in sorting/ordering to represent a number 'obviously much bigger than any item in the set being handled'.
+ * This is used instead of Number.MAX_VALUE since subtraction of MAX_VALUE from itself occassionaly doesn't equal zero exactly :-(
+ */
+export declare const MAX_ORDINAL = 100000;
+export declare const defaultEmojiHeight = 20;
+export declare const emojiPickerWidth = 350;
+export declare const sizeGap = 80;
+export declare const defaultEmojiPickerSize = "medium";
+export declare const emojiPickerMinHeight = 260;
+export declare const emojiPickerHeight = 295;
+export declare const emojiPickerListHeight: number;
+export declare const emojiPickerPreviewHeight = 54;
+export declare const emojiPickerHeightWithPreview: number;
+export declare const localStoragePrefix = "fabric.emoji";
+export declare const selectedToneStorageKey: string;
+export declare const defaultCategories: CategoryId[];
+export declare enum KeyboardKeys {
+    ArrowLeft = "ArrowLeft",
+    ArrowRight = "ArrowRight",
+    ArrowUp = "ArrowUp",
+    ArrowDown = "ArrowDown",
+    PageUp = "PageUp",
+    PageDown = "PageDown",
+    Home = "Home",
+    End = "End",
+    Enter = "Enter",
+    Tab = "Tab",
+    Space = " ",
+    Backspace = "Backspace"
+}
+export declare enum KeyboardNavigationDirection {
+    Down = "Down",
+    Up = "Up",
+    Left = "Left",
+    Right = "Right"
+}
+export declare const CATEGORYSELECTOR_KEYBOARD_KEYS_SUPPORTED: string[];
+export declare const EMOJI_KEYBOARD_KEYS_SUPPORTED: string[];
+export declare const TONESELECTOR_KEYBOARD_KEYS_SUPPORTED: string[];
+export declare const EMOJIPICKERLIST_KEYBOARD_KEYS_SUPPORTED: string[];
+export declare const DEFAULT_TONE = 0;
+export declare const defaultListLimit = 50;
+export declare const migrationUserId = "hipchat_migration_emoticons";
+export declare const analyticsEmojiPrefix = "atlassian.fabric.emoji.picker";
+export declare const EMOJI_LIST_COLUMNS = 8;
+export declare const EMOJI_LIST_PAGE_COUNT = 5;
+export declare const EMOJI_SEARCH_DEBOUNCE = 150;
+export declare const SAMPLING_RATE_EMOJI_RENDERED_EXP = 20;
+export declare const SAMPLING_RATE_EMOJI_RESOURCE_FETCHED_EXP = 100;

package/dist/types-ts4.5/util/filters.d.ts

@@ -0,0 +1,8 @@
+import { EmojiProvider } from '../api/EmojiResource';
+import { EmojiDescription, OptionalEmojiDescription } from '../types';
+export declare const getToneEmoji: (provider: EmojiProvider) => OptionalEmojiDescription | Promise<OptionalEmojiDescription>;
+declare const _default: {
+    byShortName: (emojis: EmojiDescription[], shortName: string) => EmojiDescription;
+    toneEmoji: (emojis: EmojiDescription[]) => EmojiDescription;
+};
+export default _default;

package/dist/types-ts4.5/util/image.d.ts

@@ -0,0 +1,10 @@
+export declare const getNaturalImageSize: (dataURL: string) => Promise<{
+    width: number;
+    height: number;
+}>;
+export declare const parseImage: (dataURL: string) => Promise<{
+    src: string;
+}>;
+export declare const hasFileExceededSize: (file: File) => boolean;
+export declare const checkWebpSupport: () => Promise<boolean>;
+export declare const imageAcceptHeader: () => Promise<string>;

package/dist/types-ts4.5/util/keymaps.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copied from editor-common: https://bitbucket.org/atlassian/atlassian-frontend/src/d01430a20500d720791d0667fd7cfe25d254f2e3/packages/editor/editor-common/src/keymaps/index.tsx
+ */
+export declare const backspace: Keymap;
+export interface Keymap {
+    description: string;
+    windows: string;
+    mac: string;
+    common?: string;
+}
+export declare function makeKeymap(description: string, windows: string, mac: string, common?: string): Keymap;
+export declare function makeKeyMapWithCommon(description: string, common: string): Keymap;
+export declare const arrowKeysMap: Record<string, string>;
+export declare function formatShortcut(keymap: Keymap): string | undefined;

package/dist/types-ts4.5/util/logger.d.ts

@@ -0,0 +1,4 @@
+export declare function enableLogger(enable: boolean): void;
+export declare function enableStacktraces(enable: boolean): void;
+export declare function logStacktrace(): void;
+export default function debug(msg: any, ...args: any[]): void;

package/dist/types-ts4.5/util/mouse.d.ts

@@ -0,0 +1,8 @@
+import { MouseEvent } from 'react';
+export interface Position {
+    x: number;
+    y: number;
+}
+export declare function mouseLocation(event: MouseEvent<any>): Position;
+export declare function actualMouseMove(oldPosition: Position | undefined, newPosition: Position): boolean;
+export declare function leftClick(reactEvent: MouseEvent<any>): boolean;

package/dist/types-ts4.5/util/shared-styles.d.ts

@@ -0,0 +1,11 @@
+export declare const emojiPickerListWidth = 350;
+export declare const emojiPickerListHeight = 205;
+export declare const emojiPickerBorderColor: "var(--ds-border)";
+export declare const emojiPickerBoxShadow: "var(--ds-shadow-overlay)";
+export declare const noDialogContainerBorderColor: "var(--ds-border)";
+export declare const noDialogContainerBorderRadius: "var(--ds-radius-100)";
+export declare const noDialogContainerBoxShadow: "var(--ds-shadow-overlay)";
+export declare const akEmojiSelectedBackgroundColor: "var(--ds-background-neutral-subtle-hovered)";
+export declare const emojiPreviewSelectedColor: "var(--ds-background-neutral)";
+export declare const emojiTypeAheadMaxHeight = 350;
+export declare const emojiTypeAheadWidth = 350;

package/dist/types-ts4.5/util/storage-available.d.ts

@@ -0,0 +1,3 @@
+type StorageType = 'localStorage';
+export default function storageAvailable(type: StorageType): boolean | undefined;
+export {};

package/dist/types-ts4.5/util/type-helpers.d.ts

@@ -0,0 +1,23 @@
+import { CategoryId } from '../components/picker/categories';
+import { EmojiDescription, EmojiDescriptionWithVariations, EmojiId, EmojiImageRepresentation, EmojiRepresentation, EmojiServiceRepresentation, EmojiVariationDescription, ImageRepresentation, MediaApiRepresentation, OptionalEmojiDescription, SpriteRepresentation, SpriteServiceRepresentation } from '../types';
+export declare const isSpriteServiceRepresentation: (rep: EmojiServiceRepresentation) => rep is SpriteServiceRepresentation;
+export declare const isSpriteRepresentation: (rep: EmojiRepresentation) => rep is SpriteRepresentation;
+export declare const isImageRepresentation: (rep: EmojiRepresentation | EmojiServiceRepresentation | EmojiImageRepresentation) => rep is ImageRepresentation;
+export declare const isMediaRepresentation: (rep: EmojiRepresentation | EmojiImageRepresentation) => rep is MediaApiRepresentation;
+export declare const isPromise: <T>(p: any) => p is Promise<T>;
+export declare const isEmojiDescription: (possibleEmojiDescription: any) => possibleEmojiDescription is EmojiDescription;
+export declare const isMediaEmoji: (emoji: EmojiDescription) => boolean;
+export declare const hasDataURLImage: (rep: EmojiRepresentation) => boolean;
+export declare const isLoadedMediaEmoji: (emoji: EmojiDescription) => boolean;
+export declare const isEmojiDescriptionWithVariations: (emoji: OptionalEmojiDescription) => emoji is EmojiDescriptionWithVariations;
+export declare const isEmojiVariationDescription: (object: any) => object is EmojiVariationDescription;
+export declare const isMessagesKey: (key: string) => key is "deleteEmojiTooltip" | "deleteEmojiTooltipForScreenreader" | "deleteEmojiTitle" | "deleteEmojiDescription" | "deleteEmojiLabel" | "addCustomEmojiLabel" | "emojiPlaceholder" | "emojiNameAriaLabel" | "emojiChooseFileTitle" | "emojiChooseFileScreenReaderDescription" | "emojiSelectSkinToneButtonAriaLabelText" | "emojiSelectSkinToneListAriaLabelText" | "emojiImageRequirements" | "emojiPreviewTitle" | "emojiPreview" | "addEmojiLabel" | "retryLabel" | "cancelLabel" | "searchPlaceholder" | "searchLabel" | "searchResultsStatus" | "searchResultsStatusSeeAll" | "categoriesSelectorLabel" | "categoriesSearchResults" | "frequentCategory" | "peopleCategory" | "natureCategory" | "foodsCategory" | "activityCategory" | "placesCategory" | "objectsCategory" | "symbolsCategory" | "flagsCategory" | "productivityCategory" | "userUploadsCustomCategory" | "allUploadsCustomCategory" | "deleteEmojiFailed" | "emojiInvalidImage" | "emojiUploadFailed" | "emojiImageTooBig" | "emojiPickerTitle" | "emojiPickerListPanel" | "emojiPickerGrid" | "emojiButtonRoleDescription" | "error";
+export declare const toEmojiId: (emoji: EmojiDescription) => EmojiId;
+export declare const toOptionalEmojiId: (emoji: OptionalEmojiDescription) => EmojiId | undefined;
+export declare const isEmojiIdEqual: (l?: EmojiId, r?: EmojiId) => boolean | undefined;
+export declare const containsEmojiId: (emojis: EmojiDescription[], emojiId: EmojiId | undefined) => boolean;
+export declare const convertImageToMediaRepresentation: (rep: ImageRepresentation) => MediaApiRepresentation;
+export declare const convertMediaToImageRepresentation: (rep: MediaApiRepresentation, newImagePath?: string) => ImageRepresentation;
+export declare const convertMediaToImageEmoji: (emoji: EmojiDescription, newImagePath?: string, useAlt?: boolean) => EmojiDescription;
+export declare const buildEmojiDescriptionWithAltRepresentation: (emoji: EmojiDescriptionWithVariations, altRepresentation?: EmojiRepresentation) => EmojiDescriptionWithVariations;
+export declare const getCategoryId: (emoji: EmojiDescription) => CategoryId;

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

@@ -0,0 +1,3 @@
+export { toEmojiId, toOptionalEmojiId } from './util/type-helpers';
+export { denormaliseEmojiServiceResponse } from './api/EmojiUtils';
+export { UsageFrequencyTracker } from './api/internal/UsageFrequencyTracker';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/emoji",
-  "version": "67.4.1",
+  "version": "67.4.3",
   "description": "Fabric emoji React components",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -1101,22 +1101,14 @@ interface QueueOptions {
 }
 
 // @public (undocumented)
-export const recordSelectionFailedSli: (
-  options?:
-    | undefined
-    | {
-        createAnalyticsEvent?: CreateUIAnalyticsEvent | undefined;
-      },
-) => (err: Error) => Promise<never>;
-
-// @public (undocumented)
-export const recordSelectionSucceededSli: (
-  options?:
-    | undefined
-    | {
-        createAnalyticsEvent?: CreateUIAnalyticsEvent | undefined;
-      },
-) => () => void;
+export const recordSelectionFailedSli: (options?: {
+  createAnalyticsEvent?: CreateUIAnalyticsEvent;
+}) => (err: Error) => Promise<never>;
+
+// @public (undocumented)
+export const recordSelectionSucceededSli: (options?: {
+  createAnalyticsEvent?: CreateUIAnalyticsEvent;
+}) => () => void;
 
 // @public (undocumented)
 export type RelativePosition = 'above' | 'auto' | 'below';