satteri-emoji 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Igor Koop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# satteri-emoji
+
+[![npm](https://img.shields.io/npm/v/satteri-emoji)](https://www.npmjs.com/package/satteri-emoji) [![License](https://img.shields.io/github/license/igor-koop/satteri-emoji)](https://github.com/igor-koop/satteri-emoji/blob/main/LICENSE) [![Coverage](https://codecov.io/gh/igor-koop/satteri-emoji/graph/badge.svg)](https://codecov.io/gh/igor-koop/satteri-emoji) [![Lint](https://img.shields.io/badge/lint-oxlint-ea580c)](https://oxc.rs/docs/guide/usage/linter) [![Types](https://img.shields.io/badge/types-TypeScript-3178c6)](https://www.typescriptlang.org/) [![CI](https://github.com/igor-koop/satteri-emoji/actions/workflows/ci.yml/badge.svg)](https://github.com/igor-koop/satteri-emoji/actions/workflows/ci.yml)
+
+Satteri plugin to replace emoji shortcodes and, optionally, ASCII emoticons in Markdown text.
+
+Inspired by [`remark-emoji`](https://github.com/rhysd/remark-emoji), but built for Satteri's JavaScript plugin API and powered by generated [`emojibase-data`](https://github.com/milesj/emojibase) lookup tables.
+
+## Installation
+
+```sh
+npm install satteri-emoji
+```
+
+## Usage
+
+```ts
+import { markdownToHtml } from "satteri";
+import { satteriEmoji } from "satteri-emoji";
+
+const html = markdownToHtml("Hello :waving_hand:", {
+  mdastPlugins: [satteriEmoji()],
+}).html;
+
+// <p>Hello <span class="emoji" role="img" aria-label="waving hand">👋</span></p>
+```
+
+GitHub-style names are available by opting into the GitHub shortcode dataset:
+
+```ts
+satteriEmoji({ shortcodes: ["github"] });
+```
+
+## Options
+
+| Option       | Type                       | Default    | Description                                                       |
+| ------------ | -------------------------- | ---------- | ----------------------------------------------------------------- |
+| `class`      | `string`                   | `"emoji"`  | CSS class on generated spans. Empty string omits the attribute.   |
+| `emoticons`  | `boolean`                  | `false`    | Replace ASCII emoticons like `:-)` and `:D`.                      |
+| `hidden`     | `boolean`                  | `false`    | Add `aria-hidden="true"` to generated spans.                      |
+| `label`      | `boolean`                  | `true`     | Add `role="img"` and `aria-label` to generated spans.             |
+| `locale`     | `Locale`                   | `"en"`     | Locale for accessible labels.                                     |
+| `override`   | `Record<string, Override>` | —          | Direct shortcode replacements; take precedence over all datasets. |
+| `shortcodes` | `Catalog[]`                | `["cldr"]` | Shortcode datasets to enable.                                     |
+
+Built-in datasets: `cldr`, `cldr-native`, `emojibase`, `emojibase-legacy`, `github`, `iamcal`, `joypixels`.
+
+Built-in locales: `bn`, `da`, `de`, `en`, `en-gb`, `es`, `es-mx`, `et`, `fi`, `fr`, `hi`, `hu`, `it`, `ja`, `ko`, `lt`, `ms`, `nb`, `nl`, `pl`, `pt`, `ru`, `sv`, `th`, `uk`, `vi`, `zh`, `zh-hant`.
+
+`Override` is `{ value: string; label?: string }`. When `label` is omitted the shortcode key is used as the accessible label.
+
+## Development
+
+```sh
+git clone https://github.com/igor-koop/satteri-emoji
+cd satteri-emoji
+npm install
+```
+
+| Script          | Description                                          |
+| --------------- | ---------------------------------------------------- |
+| `npm run data`  | Regenerate the emoji registry from `emojibase-data`. |
+| `npm run build` | Compile ESM and type declarations into `dist/`.      |
+| `npm test`      | Run the Vitest test suite.                           |
+| `npm run cov`   | Run tests with V8 coverage.                          |
+| `npm run check` | Format check, lint, and TypeScript typecheck.        |
+| `npm run fmt`   | Auto-format with oxfmt.                              |
+
+The package pre-generates `src/registry.ts` from `emojibase-data` so that runtime work is limited to a few lookups per plugin call rather than parsing the full Emojibase JSON on each page.
+
+## License
+
+[MIT](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,92 @@
+import type { MdastPluginInstance } from "satteri";
+import { type Locale, type Catalog } from "./registry.js";
+/** Replacement value and optional accessible label for a shortcode override. */
+export interface Override {
+    /** Text rendered in place of the matched shortcode. */
+    readonly value: string;
+    /** Accessible label exposed to assistive technology via `aria-label`.
+     * Defaults to the shortcode key when omitted.
+     */
+    readonly label?: string;
+}
+/** Configuration options for {@link satteriEmoji}. */
+export interface SatteriEmojiOptions {
+    /**
+     * CSS class of the `span` elements wrapping converted emoji and emoticon
+     * texts. Set to an empty string to omit the `class` attribute entirely.
+     *
+     * @default "emoji"
+     */
+    readonly class?: string;
+    /**
+     * Enable conversion of text emoticons such as `:-)` and `:D`.
+     *
+     * @default false
+     */
+    readonly emoticons?: boolean;
+    /**
+     * Hide converted emoji from assistive technology via `aria-hidden="true"`.
+     * Takes precedence over `label`.
+     *
+     * @default false
+     */
+    readonly hidden?: boolean;
+    /**
+     * Expose converted emoji to assistive technology via `role="img"` and
+     * `aria-label`. Ignored when `hidden` is enabled.
+     *
+     * @default true
+     */
+    readonly label?: boolean;
+    /**
+     * Locale for accessible `aria-label` text.
+     *
+     * @default "en"
+     */
+    readonly locale?: Locale;
+    /**
+     * Direct substitutions keyed by shortcode (without surrounding colons).
+     * Each entry supplies a replacement `value` and an optional accessible
+     * `label`. Overrides take precedence over every configured shortcode dataset.
+     */
+    readonly override?: Readonly<Record<string, Override>>;
+    /**
+     * Shortcode datasets used for matching.
+     *
+     * @default ["cldr"]
+     */
+    readonly shortcodes?: readonly Catalog[];
+}
+/** The plugin instance type returned by {@link satteriEmoji}. */
+export interface SatteriEmojiPlugin {
+    name: "satteri-emoji";
+    text(...args: Parameters<NonNullable<MdastPluginInstance["text"]>>): void;
+}
+/**
+ * Create the satteri mdast plugin that converts emoji shortcodes — and,
+ * optionally, text emoticons — into accessible inline `span` elements.
+ *
+ * Each match (such as `:waving_hand:`, or `:-)` when
+ * {@link SatteriEmojiOptions.emoticons} is enabled) is replaced in place with a
+ * `span` wrapping the rendered Unicode emoji. Accessibility of the `span` is
+ * controlled by the plugin options. Markdown documents receive HTML nodes,
+ * while MDX documents receive equivalent JSX elements.
+ *
+ * @param options - Plugin configuration; every field is optional and falls back
+ *   to the default documented on {@link SatteriEmojiOptions}.
+ * @returns A plugin instance to register in satteri's `mdastPlugins` option.
+ *
+ * @example
+ * ```ts
+ * import { markdownToHtml } from "satteri";
+ * import { satteriEmoji } from "satteri-emoji";
+ *
+ * const { html } = markdownToHtml("Hello :waving_hand:", {
+ *   mdastPlugins: [satteriEmoji()],
+ * });
+ * // html === '<p>Hello <span class="emoji" role="img" aria-label="waving hand">👋</span></p>\n'
+ * ```
+ */
+export declare function satteriEmoji(options?: SatteriEmojiOptions): SatteriEmojiPlugin;
+export default satteriEmoji;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEnD,OAAO,EAOL,KAAK,MAAM,EACX,KAAK,OAAO,EACb,MAAM,eAAe,CAAC;AAKvB,gFAAgF;AAChF,MAAM,WAAW,QAAQ;IACvB,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,sDAAsD;AACtD,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEvD;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;CAC1C;AAED,iEAAiE;AACjE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAC3E;AAqBD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,YAAY,CAAC,OAAO,GAAE,mBAAwB,GAAG,kBAAkB,CAyDlF;AAyID,eAAe,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,184 @@
+import { defineMdastPlugin } from "satteri";
+import { HEXCODES, RE_EMOJI, RE_EMOTICON, EMOTICONS, LABELS, SHORTCODES, } from "./registry.js";
+/** HTML special characters mapped to their entity equivalents. */
+const HTML_ENTITIES = {
+    "&": "&",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+};
+/**
+ * Create the satteri mdast plugin that converts emoji shortcodes — and,
+ * optionally, text emoticons — into accessible inline `span` elements.
+ *
+ * Each match (such as `:waving_hand:`, or `:-)` when
+ * {@link SatteriEmojiOptions.emoticons} is enabled) is replaced in place with a
+ * `span` wrapping the rendered Unicode emoji. Accessibility of the `span` is
+ * controlled by the plugin options. Markdown documents receive HTML nodes,
+ * while MDX documents receive equivalent JSX elements.
+ *
+ * @param options - Plugin configuration; every field is optional and falls back
+ *   to the default documented on {@link SatteriEmojiOptions}.
+ * @returns A plugin instance to register in satteri's `mdastPlugins` option.
+ *
+ * @example
+ * ```ts
+ * import { markdownToHtml } from "satteri";
+ * import { satteriEmoji } from "satteri-emoji";
+ *
+ * const { html } = markdownToHtml("Hello :waving_hand:", {
+ *   mdastPlugins: [satteriEmoji()],
+ * });
+ * // html === '<p>Hello <span class="emoji" role="img" aria-label="waving hand">👋</span></p>\n'
+ * ```
+ */
+export function satteriEmoji(options = {}) {
+    const config = {
+        class: options.class ?? "emoji",
+        emoticons: options.emoticons ?? false,
+        hidden: options.hidden ?? false,
+        label: options.label ?? true,
+        locale: options.locale ?? "en",
+        override: options.override,
+        shortcodes: options.shortcodes ?? ["cldr"],
+    };
+    const labels = LABELS[config.locale] ?? LABELS.en;
+    const shortcodes = {};
+    const replacements = new RegExp(config.emoticons ? `${RE_EMOJI}|(?<prefix>^|\\s)(?<emoticon>${RE_EMOTICON})` : RE_EMOJI, "g");
+    for (const dataset of config.shortcodes) {
+        Object.assign(shortcodes, SHORTCODES[dataset]);
+    }
+    return defineMdastPlugin({
+        name: "satteri-emoji",
+        text(node, ctx) {
+            const mdx = isMdx(ctx.fileURL);
+            let offset = 0;
+            for (const match of node.value.matchAll(replacements)) {
+                const resolved = resolveMatch(match, shortcodes, config.override, labels);
+                if (resolved === null)
+                    continue;
+                const { value, label, index, source } = resolved;
+                if (index > offset) {
+                    ctx.insertBefore(node, { type: "text", value: node.value.slice(offset, index) });
+                }
+                const attributes = createAttributes(config, label);
+                ctx.insertBefore(node, mdx ? createMdxSpan(value, attributes) : createHtmlSpan(value, attributes));
+                offset = index + source.length;
+            }
+            if (offset === 0) {
+                return;
+            }
+            if (offset < node.value.length) {
+                ctx.insertBefore(node, { type: "text", value: node.value.slice(offset) });
+            }
+            ctx.removeNode(node);
+        },
+    });
+}
+/**
+ * Resolve a regex match to its rendered value, accessible label, text index,
+ * and matched source string. Returns `null` when the match has no emoji mapping.
+ *
+ * @param match - A match from {@link String.prototype.matchAll}.
+ * @param shortcodes - Merged shortcode-to-hexcode lookup.
+ * @param overrides - Direct shortcode overrides from the plugin config.
+ * @param labels - Locale-specific hexcode-to-label lookup.
+ */
+function resolveMatch(match, shortcodes, overrides, labels) {
+    const { shortcode, prefix = "", emoticon, } = match.groups;
+    const source = shortcode !== undefined ? match[0] : emoticon;
+    const index = match.index + prefix.length;
+    const hexcode = shortcode === undefined ? EMOTICONS[source] : shortcodes[shortcode];
+    const override = shortcode !== undefined && overrides !== undefined && Object.hasOwn(overrides, shortcode)
+        ? overrides[shortcode]
+        : undefined;
+    const value = override ? override.value : hexcode !== undefined ? HEXCODES[hexcode] : undefined;
+    if (value === undefined)
+        return null;
+    const label = override ? (override.label ?? shortcode) : labels[hexcode];
+    return { value, label, index, source };
+}
+/**
+ * Returns `true` when the document URL ends with `.mdx` (case-insensitive),
+ * `false` otherwise. A missing URL is treated as plain Markdown.
+ *
+ * @param fileURL - The document URL exposed as `ctx.fileURL`, or `undefined`.
+ */
+function isMdx(fileURL) {
+    return fileURL?.pathname.toLowerCase().endsWith(".mdx") ?? false;
+}
+/**
+ * Build the `span` attribute map for a single converted emoji or emoticon.
+ *
+ * When `hidden` is set, only `aria-hidden="true"` is emitted. Otherwise,
+ * `label` adds `role="img"` and `aria-label`. An empty `class` omits the
+ * respective attribute.
+ *
+ * @param config - Resolved plugin options.
+ * @param label - Accessible name used as the `aria-label` value.
+ * @returns Attribute name/value pairs ready for HTML serialization or MDX JSX mapping.
+ */
+function createAttributes(config, label) {
+    const attributes = {};
+    if (config.class) {
+        attributes["class"] = config.class;
+    }
+    if (config.hidden) {
+        attributes["aria-hidden"] = "true";
+        return attributes;
+    }
+    if (config.label) {
+        attributes["role"] = "img";
+        attributes["aria-label"] = label;
+    }
+    return attributes;
+}
+/**
+ * Build an `mdxJsxTextElement` span node wrapping the given text.
+ *
+ * @param value - The emoji text to render inside the span.
+ * @param attributes - Attribute name/value pairs to set on the element.
+ */
+function createMdxSpan(value, attributes) {
+    return {
+        type: "mdxJsxTextElement",
+        name: "span",
+        attributes: Object.entries(attributes).map(([name, value]) => ({
+            type: "mdxJsxAttribute",
+            name,
+            value,
+        })),
+        data: { _mdxExplicitJsx: true },
+        children: [{ type: "text", value }],
+    };
+}
+/**
+ * Build an `html` span node wrapping the given text.
+ *
+ * @param value - The emoji text to render inside the span.
+ * @param attributes - Attribute name/value pairs to serialize as HTML attributes.
+ */
+function createHtmlSpan(value, attributes) {
+    return {
+        type: "html",
+        value: `<span ${Object.entries(attributes)
+            .map(([name, value]) => `${name}="${escapeHtml(value)}"`)
+            .join(" ")}>${escapeHtml(value)}</span>`,
+    };
+}
+/**
+ * Escape `&`, `<`, `>`, and `"` to their HTML entity equivalents.
+ *
+ * @param value - The raw string to escape.
+ * @returns The escaped string, safe for HTML text and double-quoted attributes.
+ *
+ * @example
+ * ```ts
+ * escapeHtml('Tom & Jerry'); // 'Tom &amp; Jerry'
+ * ```
+ */
+function escapeHtml(value) {
+    return value.replace(/[&<>"]/g, (c) => HTML_ENTITIES[c]);
+}
+export default satteriEmoji;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAG5C,OAAO,EACL,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,SAAS,EACT,MAAM,EACN,UAAU,GAGX,MAAM,eAAe,CAAC;AAwFvB,kEAAkE;AAClE,MAAM,aAAa,GAA2B;IAC5C,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,QAAQ;CACd,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,YAAY,CAAC,UAA+B,EAAE;IAC5D,MAAM,MAAM,GAAW;QACrB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,OAAO;QAC/B,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK;QACrC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;QAC/B,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;QAC9B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC;KAC3C,CAAC;IAEF,MAAM,MAAM,GAAI,MAA2C,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC;IACxF,MAAM,UAAU,GAA2B,EAAE,CAAC;IAC9C,MAAM,YAAY,GAAG,IAAI,MAAM,CAC7B,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,QAAQ,gCAAgC,WAAW,GAAG,CAAC,CAAC,CAAC,QAAQ,EACvF,GAAG,CACJ,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAG,UAA+C,CAAC,OAAO,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,iBAAiB,CAAC;QACvB,IAAI,EAAE,eAAe;QACrB,IAAI,CAAC,IAAI,EAAE,GAAG;YACZ,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC/B,IAAI,MAAM,GAAG,CAAC,CAAC;YAEf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;gBACtD,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC1E,IAAI,QAAQ,KAAK,IAAI;oBAAE,SAAS;gBAChC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;gBAEjD,IAAI,KAAK,GAAG,MAAM,EAAE,CAAC;oBACnB,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;gBACnF,CAAC;gBAED,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;gBAEnD,GAAG,CAAC,YAAY,CACd,IAAI,EACJ,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,CAC3E,CAAC;gBACF,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;YACjC,CAAC;YAED,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;gBACjB,OAAO;YACT,CAAC;YAED,IAAI,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC/B,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC5E,CAAC;YAED,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,YAAY,CACnB,KAAuB,EACvB,UAAkC,EAClC,SAA6B,EAC7B,MAAc;IAOd,MAAM,EACJ,SAAS,EACT,MAAM,GAAG,EAAE,EACX,QAAQ,GACT,GAAG,KAAK,CAAC,MAIT,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAS,CAAC;IAC9D,MAAM,KAAK,GAAG,KAAK,CAAC,KAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,MAAM,OAAO,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACpF,MAAM,QAAQ,GACZ,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC;QACvF,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;QACtB,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEhG,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAErC,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,IAAI,SAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAQ,CAAE,CAAC;IAC5E,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,SAAS,KAAK,CAAC,OAAkD;IAC/D,OAAO,OAAO,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC;AACnE,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,gBAAgB,CAAC,MAAc,EAAE,KAAa;IACrD,MAAM,UAAU,GAA2B,EAAE,CAAC;IAE9C,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,UAAU,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;IACrC,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,UAAU,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;QACnC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QAC3B,UAAU,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;IACnC,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,KAAa,EAAE,UAAkC;IACtE,OAAO;QACL,IAAI,EAAE,mBAA4B;QAClC,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;YAC7D,IAAI,EAAE,iBAA0B;YAChC,IAAI;YACJ,KAAK;SACN,CAAC,CAAC;QACH,IAAI,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE;QAC/B,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,KAAK,EAAE,CAAC;KAC7C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,KAAa,EAAE,UAAkC;IACvE,OAAO;QACL,IAAI,EAAE,MAAe;QACrB,KAAK,EAAE,SAAS,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;aACvC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC;aACxD,IAAI,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,SAAS;KAC3C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAE,CAAC,CAAC;AAC5D,CAAC;AAED,eAAe,YAAY,CAAC"}

package/dist/registry.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Regular expression source matching emoji shortcodes.
+ */
+export declare const RE_EMOJI: ":(?<shortcode>[^:\\s]+):";
+/**
+ * Regular expression matching text emoticons.
+ */
+export declare const RE_EMOTICON: "\\\\[Mm]\\/|<\\/?3|>:[\\(\\)\\/]|>0\\)|[Oo]:\\)|:(?:\\{>|\\'[\\(\\)Do]|[#\\$&\\(-\\*\\/3<>-@B-ELOPSXZcjlopsxz\\|])|D[:x]|%\\(|8[#\\)D]|;[\\)Pp]|X[\\(DOP]|x[\\(DPop]";
+/**
+ * Built-in locale identifiers.
+ */
+export type Locale = "bn" | "da" | "de" | "en" | "en-gb" | "es" | "es-mx" | "et" | "fi" | "fr" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "ms" | "nb" | "nl" | "pl" | "pt" | "ru" | "sv" | "th" | "uk" | "vi" | "zh" | "zh-hant";
+/**
+ * Built-in shortcode catalog identifiers.
+ */
+export type Catalog = "cldr" | "cldr-native" | "emojibase" | "emojibase-legacy" | "github" | "iamcal" | "joypixels";
+/**
+ * Emoji hexcode identifier.
+ */
+export type Hexcode = string;
+/**
+ * Maps emoji hexcodes to rendered Unicode emoji.
+ *
+ * Example: `HEXCODES["1F600"] -> "😀"`.
+ */
+export declare const HEXCODES: Record<Hexcode, string>;
+/**
+ * Maps catalog names to emoji shortcodes by hexcode.
+ *
+ * Example: `SHORTCODES.github["+1"] -> "1F44D"`.
+ */
+export declare const SHORTCODES: Record<Catalog, Record<string, Hexcode>>;
+/**
+ * Maps text emoticons to emoji hexcodes.
+ *
+ * Example: `EMOTICONS[":)"] -> "1F642"`.
+ */
+export declare const EMOTICONS: Record<string, Hexcode>;
+/**
+ * Maps locale identifiers to emoji labels by hexcode.
+ *
+ * Example: `LABELS.en["1F600"] -> "grinning face"`.
+ */
+export declare const LABELS: Record<Locale, Record<Hexcode, string>>;
+//# sourceMappingURL=registry.d.ts.map

package/dist/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAG,0BAAmC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,WAAW,EACtB,sKAA+K,CAAC;AAElL;;GAEG;AACH,MAAM,MAAM,MAAM,GACd,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,OAAO,GACf,MAAM,GACN,aAAa,GACb,WAAW,GACX,kBAAkB,GAClB,QAAQ,GACR,QAAQ,GACR,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;;;GAIG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CA85D5C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAk1tB/D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAiE7C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CA63qD1D,CAAC"}