emojibase
Version:
Emojibase utility functions for working with emoji characters.
584 lines (548 loc) • 21.1 kB
JavaScript
// Bundled with Packemon: https://packemon.dev
// Platform: browser, Support: stable, Format: lib
;
/**
* Append a skin tone index (number) to the end of a shortcode.
*/
const _excluded = ["local", "version", "cdnUrl"],
_excluded2 = ["skins"],
_excluded3 = ["compact", "flat", "shortcodes"];
function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
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; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], t.indexOf(o) >= 0 || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.indexOf(n) >= 0) continue; t[n] = r[n]; } return t; }
function appendSkinToneIndex(shortcode, emoji, prefix = '') {
return `${shortcode}_${prefix}${Array.isArray(emoji.tone) ? emoji.tone.join('-') : emoji.tone}`;
}
const SEQUENCE_REMOVAL_PATTERN = /200D|FE0E|FE0F/g;
// Use numbers instead of string values, as the filesize is greatly reduced.
const TEXT = 0;
const EMOJI = 1;
const FEMALE = 0;
const MALE = 1;
const FULLY_QUALIFIED = 0;
const MINIMALLY_QUALIFIED = 1;
const UNQUALIFIED = 2;
const LIGHT_SKIN = 1;
const MEDIUM_LIGHT_SKIN = 2;
const MEDIUM_SKIN = 3;
const MEDIUM_DARK_SKIN = 4;
const DARK_SKIN = 5;
const GROUP_KEY_SMILEYS_EMOTION = 'smileys-emotion';
const GROUP_KEY_PEOPLE_BODY = 'people-body';
const GROUP_KEY_ANIMALS_NATURE = 'animals-nature';
const GROUP_KEY_FOOD_DRINK = 'food-drink';
const GROUP_KEY_TRAVEL_PLACES = 'travel-places';
const GROUP_KEY_ACTIVITIES = 'activities';
const GROUP_KEY_OBJECTS = 'objects';
const GROUP_KEY_SYMBOLS = 'symbols';
const GROUP_KEY_FLAGS = 'flags';
const GROUP_KEY_COMPONENT = 'component';
const SKIN_KEY_LIGHT = 'light';
const SKIN_KEY_MEDIUM_LIGHT = 'medium-light';
const SKIN_KEY_MEDIUM = 'medium';
const SKIN_KEY_MEDIUM_DARK = 'medium-dark';
const SKIN_KEY_DARK = 'dark';
// Important release versions and locales in generating accurate data.
const LATEST_EMOJI_VERSION = '16.0';
const LATEST_UNICODE_VERSION = '16.0.0';
const LATEST_CLDR_VERSION = '46';
const FIRST_UNICODE_EMOJI_VERSION = '6.0.0';
const EMOJI_VERSIONS = ['1.0', '2.0', '3.0', '4.0', '5.0', '11.0', '12.0', '12.1', '13.0', '13.1', '14.0', '15.0', '15.1', '16.0'];
const UNICODE_VERSIONS = ['6.0', '6.1', '6.2', '6.3', '7.0', '8.0', '9.0', '10.0', '11.0', '12.0', '12.1', '13.0', '14.0', '15.0', '15.1', '16.0'];
const SUPPORTED_LOCALES = ['bn',
// Bangla
'da',
// Danish
'de',
// German
'en',
// English
'en-gb',
// English (Great Britain)
'es',
// Spanish
'es-mx',
// Spanish (Mexico)
'et',
// Estonian
'fi',
// Finnish
'fr',
// French
'hi',
// Hindi
'hu',
// Hungarian
'it',
// Italian
'ja',
// Japanese
'ko',
// Korean
'lt',
// Lithuanian
'ms',
// Malay
'nb',
// Norwegian
'nl',
// Dutch
'pl',
// Polish
'pt',
// Portuguese
'ru',
// Russian
'sv',
// Swedish
'th',
// Thai
'uk',
// Ukrainian
'vi',
// Vietnamese
'zh',
// Chinese
'zh-hant' // Chinese (Traditional)
];
// Special options for emoticon permutations.
const EMOTICON_OPTIONS = {
// 🧙♂️ man mage
':{>': {
withNose: false
},
// 💔 broken heart
'</3': {
isFace: false
},
// ❤️ red heart
'<3': {
isFace: false
},
// 🤘 sign of the horns
'\\m/': {
isFace: false
},
'\\M/': {
isFace: false
},
// 👹 ogre
'0)': {
withNose: false
}
};
function getFetchUrl(path, version, cdnUrl) {
let fetchUrl = `https://cdn.jsdelivr.net/npm/emojibase-data@${version}/${path}`;
if (typeof cdnUrl === 'function') {
fetchUrl = cdnUrl(path, version);
} else if (typeof cdnUrl === 'string') {
fetchUrl = `${cdnUrl}/${path}`;
}
if (process.env.NODE_ENV !== "production") {
if (!path?.endsWith('.json')) {
throw new Error('A valid JSON dataset is required to fetch.');
}
if (!fetchUrl || !/^https?:\/\//.test(fetchUrl) || !fetchUrl.endsWith('.json')) {
throw new Error('A valid CDN url is required to fetch.');
}
if (!version) {
throw new Error('A valid release version is required.');
}
}
return fetchUrl;
}
/**
* This function will fetch `emojibase-data` JSON files from our CDN, parse them,
* and return the response. It requires a file path relative to the `emojibase-data` package
* as the 1st argument and an optional object of options as the 2rd argument.
*
* ```ts
* import { fetchFromCDN } from 'emojibase';
*
* await fetchFromCDN('ja/compact.json', { version: '2.1.3' });
* await fetchFromCDN('ja/compact.json', { cdnUrl: 'https://example.com/cdn/emojidata/latest' });
* await fetchFromCDN('ja/compact.json', {
* cdnUrl: (path: string, version: string) => {
* return `https://example.com/cdn/emojidata/${version}/${path}`;
* }
* });
* ```
*/
async function fetchFromCDN(path, options = {}) {
const _options$local = options.local,
local = _options$local === void 0 ? false : _options$local,
_options$version = options.version,
version = _options$version === void 0 ? 'latest' : _options$version,
cdnUrl = options.cdnUrl,
opts = _objectWithoutProperties(options, _excluded);
const fetchUrl = getFetchUrl(path, version, cdnUrl);
const storage = local ? localStorage : sessionStorage;
const cacheKey = `emojibase/${version}/${path}`;
const cachedData = storage.getItem(cacheKey);
// Check the cache first
if (cachedData) {
return JSON.parse(cachedData);
}
// eslint-disable-next-line compat/compat
const response = await fetch(fetchUrl, _objectSpread({
credentials: 'omit',
mode: 'cors',
redirect: 'error'
}, opts));
if (!response.ok) {
throw new Error('Failed to load Emojibase dataset.');
}
const data = await response.json();
try {
storage.setItem(cacheKey, JSON.stringify(data));
} catch {
// Do not allow quota errors to break the app
}
return data;
}
const ALIASES = {
discord: 'joypixels',
slack: 'iamcal'
};
/**
* Fetches and returns localized shortcodes for the defined preset from our CDN.
* The response is a mapping of emoji hexcodes to shortcodes (either a string or array of strings).
* Uses `fetchFromCDN` under the hood.
*
* ```ts
* import { fetchShortcodes } from 'emojibase';
*
* await fetchShortcodes('ja', 'cldr', { version: '2.1.3' });
* ```
*/
async function fetchShortcodes(locale, preset, options) {
return fetchFromCDN(`${locale}/shortcodes/${ALIASES[preset] ?? preset}.json`, options);
}
/**
* Will join shortcodes from multiple shortcode datasets into a single emoji object
* using its hexcode. Will remove duplicates in the process.
*/
function joinShortcodesToEmoji(emoji, shortcodeDatasets) {
if (shortcodeDatasets.length === 0) {
return emoji;
}
const list = new Set(emoji.shortcodes);
shortcodeDatasets.forEach(dataset => {
const shortcodes = dataset[emoji.hexcode];
if (Array.isArray(shortcodes)) {
shortcodes.forEach(code => list.add(code));
} else if (shortcodes) {
list.add(shortcodes);
}
});
// eslint-disable-next-line no-param-reassign
emoji.shortcodes = [...list];
if (emoji.skins) {
emoji.skins.forEach(skin => {
joinShortcodesToEmoji(skin, shortcodeDatasets);
});
}
return emoji;
}
/**
* By default, emoji skin modifications are nested under the base neutral skin tone emoji.
* To flatten the data into a single dimension array, use the `flattenEmojiData` function.
*
* If `shortcodeDatasets` is defined, it will join the shortcodes to the emoji object using
* `joinShortcodesToEmoji`.
*
* > Tags from the parent emoji will be passed down to the skin modifications.
*/
function flattenEmojiData(data, shortcodeDatasets = []) {
const emojis = [];
data.forEach(emoji => {
if (emoji.skins) {
// Dont include nested skins array
const skins = emoji.skins,
baseEmoji = _objectWithoutProperties(emoji, _excluded2);
emojis.push(joinShortcodesToEmoji(baseEmoji, shortcodeDatasets));
// Push each skin modification into the root list
skins.forEach(skin => {
const skinEmoji = _objectSpread({}, skin);
// Inherit tags from parent if they exist
if (baseEmoji.tags) {
skinEmoji.tags = [...baseEmoji.tags];
}
emojis.push(joinShortcodesToEmoji(skinEmoji, shortcodeDatasets));
});
} else {
emojis.push(joinShortcodesToEmoji(emoji, shortcodeDatasets));
}
});
return emojis;
}
/**
* Like `joinShortcodesToEmoji` but joins shortcodes to a list of emoji objects.
*/
function joinShortcodes(emojis, shortcodeDatasets) {
if (shortcodeDatasets.length === 0) {
return emojis;
}
emojis.forEach(emoji => {
joinShortcodesToEmoji(emoji, shortcodeDatasets);
});
return emojis;
}
/**
* Fetches and returns a localized list of emojis (and optional shortcodes) from our CDN.
* Uses `fetchFromCDN` and `fetchShortcodes` under the hood.
*
* ```ts
* import { fetchEmojis } from 'emojibase';
*
* await fetchEmojis('ja', {
* compact: true,
* shortcodes: ['cldr'],
* version: '2.1.3',
* });
* ```
*
* It's also possible to load shortcodes from other languages by prefixing the shortcode preset with
* the chosen locale. This is useful if you want to support English and Japanese in parallel, for
* example.
*
* ```ts
* await fetchEmojis('ja', {
* shortcodes: ['cldr', 'en/cldr'],
* });
* ```
*/
async function fetchEmojis(locale, options = {}) {
const _options$compact = options.compact,
compact = _options$compact === void 0 ? false : _options$compact,
_options$flat = options.flat,
flat = _options$flat === void 0 ? false : _options$flat,
_options$shortcodes = options.shortcodes,
presets = _options$shortcodes === void 0 ? [] : _options$shortcodes,
opts = _objectWithoutProperties(options, _excluded3);
const emojis = await fetchFromCDN(`${locale}/${compact ? 'compact' : 'data'}.json`, opts);
let shortcodes = [];
if (presets.length > 0) {
shortcodes = await Promise.all(presets.map(preset => {
let promise;
if (preset.includes('/')) {
const _preset$split = preset.split('/'),
_preset$split2 = _slicedToArray(_preset$split, 2),
customLocale = _preset$split2[0],
customPreset = _preset$split2[1];
promise = fetchShortcodes(customLocale, customPreset, opts);
} else {
promise = fetchShortcodes(locale, preset, opts);
}
// Ignore as the primary dataset should still load
return promise.catch(() => ({}));
}));
}
return flat ? flattenEmojiData(emojis, shortcodes) : joinShortcodes(emojis, shortcodes);
}
/**
* Fetches and returns localized messages for emoji related information like groups and sub-groups.
* Uses `fetchFromCDN` under the hood.
*
* ```ts
* import { fetchMessages } from 'emojibase';
*
* await fetchMessages('zh', { version: '2.1.3' });
* ```
*/
async function fetchMessages(locale, options) {
return fetchFromCDN(`${locale}/messages.json`, options);
}
/**
* This function will convert an array of numerical codepoints to a literal emoji Unicode character.
*
* ```ts
* import { fromCodepointToUnicode } from 'emojibase';
*
* fromCodepointToUnicode([128104, 8205, 128105, 8205, 128103, 8205, 128102]); // 👨👩👧👦
* ```
*/
function fromCodepointToUnicode(codepoint) {
return String.fromCodePoint(...codepoint);
}
/**
* This function will convert a hexadecimal codepoint to an array of numerical codepoints.
* By default, it will split the hexcode using a dash, but can be customized with the 2nd argument.
*
* ```ts
* import { fromHexcodeToCodepoint } from 'emojibase';
*
* fromHexcodeToCodepoint('270A-1F3FC'); // [9994, 127996]
* fromHexcodeToCodepoint('270A 1F3FC', ' '); // [9994, 127996]
* ```
*/
function fromHexcodeToCodepoint(code, joiner = '-') {
return code.split(joiner).map(point => Number.parseInt(point, 16));
}
/**
* This function will convert a literal emoji Unicode character into a dash separated
* hexadecimal codepoint. Unless `false` is passed as the 2nd argument, zero width
* joiner's and variation selectors are removed.
*
* ```ts
* import { fromUnicodeToHexcode } from 'emojibase';
*
* fromUnicodeToHexcode('👨👩👧👦'); // 1F468-1F469-1F467-1F466
* fromUnicodeToHexcode('👨👩👧👦', false); // 1F468-200D-1F469-200D-1F467-200D-1F466
* ```
*/
function fromUnicodeToHexcode(unicode, strip = true) {
const hexcode = [];
[...unicode].forEach(codepoint => {
let hex = codepoint.codePointAt(0)?.toString(16).toUpperCase() ?? '';
while (hex.length < 4) {
hex = `0${hex}`;
}
if (!strip || strip && !hex.match(SEQUENCE_REMOVAL_PATTERN)) {
hexcode.push(hex);
}
});
return hexcode.join('-');
}
/**
* This function will generate multiple permutations of a base emoticon character.
* The following permutations will occur:
*
* - `)` mouth will be replaced with `]` and `}`. The same applies to sad/frowning mouths.
* - `/` mouth will be replaced with `\`.
* - `:` eyes will be replaced with `=`.
* - Supports a `-` nose, by injecting between the eyes and mouth.
* - Supports both uppercase and lowercase variants.
*
* ```ts
* import { generateEmoticonPermutations } from 'emojibase';
*
* generateEmoticonPermutations(':)'); // =-), =-}, :-], =-], :-}, :-), =}, =], =), :}, :], :)
* ```
*
* > The base emoticon must follow a set of naming guidelines to work properly.
*
* Furthermore, this function accepts an options object as the 2nd argument, as a means to customize
* the output.
*
* - `isFace` (bool) - Toggles face permutations (mouth and eye variants). Defaults to `true`.
* - `withNose` (bool) - Toggles nose inclusion. Defaults to `true`.
*
* ```ts
* generateEmoticonPermutations(':)', { withNose: false }); // =}, =], =), :}, :], :)
* generateEmoticonPermutations('\\m/', { isFace: false }); // \m/, \M/
* ```
*/
function generateEmoticonPermutations(emoticon, options = {}) {
const _options$isFace = options.isFace,
isFace = _options$isFace === void 0 ? true : _options$isFace,
_options$withNose = options.withNose,
withNose = _options$withNose === void 0 ? true : _options$withNose;
const list = [emoticon];
// Uppercase variant
if (emoticon.toUpperCase() !== emoticon) {
list.push(...generateEmoticonPermutations(emoticon.toUpperCase(), options));
}
if (isFace) {
// Backwards slash mouth variant
if (emoticon.includes('/')) {
list.push(...generateEmoticonPermutations(emoticon.replace('/', '\\'), options));
}
// Bracket and curly brace mouth variants
if (emoticon.includes(')')) {
list.push(...generateEmoticonPermutations(emoticon.replace(')', ']'), options), ...generateEmoticonPermutations(emoticon.replace(')', '}'), options));
}
if (emoticon.includes('(')) {
list.push(...generateEmoticonPermutations(emoticon.replace('(', '['), options), ...generateEmoticonPermutations(emoticon.replace('(', '{'), options));
}
// Eye variant
if (emoticon.includes(':')) {
list.push(...generateEmoticonPermutations(emoticon.replace(':', '='), options));
}
// Nose variant for ALL
if (withNose) {
list.forEach(emo => {
if (!emo.includes('-')) {
list.push(`${emo.slice(0, -1)}-${emo.slice(-1)}`);
}
});
}
}
// Sort from longest to shortest
list.sort((a, b) => b.length - a.length);
return [...new Set(list)];
}
const STRIP_PATTERN = new RegExp(`(-| )?(${SEQUENCE_REMOVAL_PATTERN.source})`, 'g');
/**
* This function will strip zero width joiners (`200D`) and variation selectors
* (`FE0E`, `FE0F`) from a hexadecimal codepoint.
*
* ```ts
* import { stripHexcode } from 'emojibase';
*
* stripHexcode('1F468-200D-2695-FE0F'); // 1F468-2695
* ```
*/
function stripHexcode(hexcode) {
return hexcode.replace(STRIP_PATTERN, '');
}
exports.DARK_SKIN = DARK_SKIN;
exports.EMOJI = EMOJI;
exports.EMOJI_VERSIONS = EMOJI_VERSIONS;
exports.EMOTICON_OPTIONS = EMOTICON_OPTIONS;
exports.FEMALE = FEMALE;
exports.FIRST_UNICODE_EMOJI_VERSION = FIRST_UNICODE_EMOJI_VERSION;
exports.FULLY_QUALIFIED = FULLY_QUALIFIED;
exports.GROUP_KEY_ACTIVITIES = GROUP_KEY_ACTIVITIES;
exports.GROUP_KEY_ANIMALS_NATURE = GROUP_KEY_ANIMALS_NATURE;
exports.GROUP_KEY_COMPONENT = GROUP_KEY_COMPONENT;
exports.GROUP_KEY_FLAGS = GROUP_KEY_FLAGS;
exports.GROUP_KEY_FOOD_DRINK = GROUP_KEY_FOOD_DRINK;
exports.GROUP_KEY_OBJECTS = GROUP_KEY_OBJECTS;
exports.GROUP_KEY_PEOPLE_BODY = GROUP_KEY_PEOPLE_BODY;
exports.GROUP_KEY_SMILEYS_EMOTION = GROUP_KEY_SMILEYS_EMOTION;
exports.GROUP_KEY_SYMBOLS = GROUP_KEY_SYMBOLS;
exports.GROUP_KEY_TRAVEL_PLACES = GROUP_KEY_TRAVEL_PLACES;
exports.LATEST_CLDR_VERSION = LATEST_CLDR_VERSION;
exports.LATEST_EMOJI_VERSION = LATEST_EMOJI_VERSION;
exports.LATEST_UNICODE_VERSION = LATEST_UNICODE_VERSION;
exports.LIGHT_SKIN = LIGHT_SKIN;
exports.MALE = MALE;
exports.MEDIUM_DARK_SKIN = MEDIUM_DARK_SKIN;
exports.MEDIUM_LIGHT_SKIN = MEDIUM_LIGHT_SKIN;
exports.MEDIUM_SKIN = MEDIUM_SKIN;
exports.MINIMALLY_QUALIFIED = MINIMALLY_QUALIFIED;
exports.SEQUENCE_REMOVAL_PATTERN = SEQUENCE_REMOVAL_PATTERN;
exports.SKIN_KEY_DARK = SKIN_KEY_DARK;
exports.SKIN_KEY_LIGHT = SKIN_KEY_LIGHT;
exports.SKIN_KEY_MEDIUM = SKIN_KEY_MEDIUM;
exports.SKIN_KEY_MEDIUM_DARK = SKIN_KEY_MEDIUM_DARK;
exports.SKIN_KEY_MEDIUM_LIGHT = SKIN_KEY_MEDIUM_LIGHT;
exports.SUPPORTED_LOCALES = SUPPORTED_LOCALES;
exports.TEXT = TEXT;
exports.UNICODE_VERSIONS = UNICODE_VERSIONS;
exports.UNQUALIFIED = UNQUALIFIED;
exports.appendSkinToneIndex = appendSkinToneIndex;
exports.fetchEmojis = fetchEmojis;
exports.fetchFromCDN = fetchFromCDN;
exports.fetchMessages = fetchMessages;
exports.fetchShortcodes = fetchShortcodes;
exports.flattenEmojiData = flattenEmojiData;
exports.fromCodepointToUnicode = fromCodepointToUnicode;
exports.fromHexcodeToCodepoint = fromHexcodeToCodepoint;
exports.fromUnicodeToHexcode = fromUnicodeToHexcode;
exports.generateEmoticonPermutations = generateEmoticonPermutations;
exports.joinShortcodes = joinShortcodes;
exports.joinShortcodesToEmoji = joinShortcodesToEmoji;
exports.stripHexcode = stripHexcode;
//# sourceMappingURL=index.js.map