@etrepum/lexical-emoji-plan 0.0.13-nightly.20240605.0 → 0.0.13

package/dist/EmojiNode.d.ts

@@ -12,7 +12,8 @@ export type SerializedEmojiNode = Spread<{
  * transforms.
  *
  * The display behavior is all implemented in the mutation listener set up
- * by EmojiPlan.
+ * by EmojiPlan, which makes it a little easier to ensure that clean-up is
+ * done properly.
  */
 export declare class EmojiNode extends TextNode {
     static getType(): "emoji";

package/dist/EmojiNode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EmojiNode.d.ts","sourceRoot":"","sources":["../src/EmojiNode.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEvE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,MAAM,MAAM,mBAAmB,GAAG,MAAM,CACtC;IACE,IAAI,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;CAC5C,EACD,kBAAkB,CACnB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,SAAU,SAAQ,QAAQ;IACrC,MAAM,CAAC,OAAO,IAAI,OAAO;IAIzB,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IAIxC,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,mBAAmB,GAAG,SAAS;IAIjE,UAAU,IAAI,mBAAmB;CAMlC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAMxD;AAED,wBAAgB,YAAY,CAC1B,IAAI,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,GACnC,IAAI,IAAI,SAAS,CAEnB"}
+{"version":3,"file":"EmojiNode.d.ts","sourceRoot":"","sources":["../src/EmojiNode.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEvE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,MAAM,MAAM,mBAAmB,GAAG,MAAM,CACtC;IACE,IAAI,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;CAC5C,EACD,kBAAkB,CACnB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,SAAU,SAAQ,QAAQ;IACrC,MAAM,CAAC,OAAO,IAAI,OAAO;IAIzB,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IAIxC,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,mBAAmB,GAAG,SAAS;IAIjE,UAAU,IAAI,mBAAmB;CAMlC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAMxD;AAED,wBAAgB,YAAY,CAC1B,IAAI,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,GACnC,IAAI,IAAI,SAAS,CAEnB"}

package/dist/EmojiPlan.d.ts

@@ -8,8 +8,20 @@
 export declare const PACKAGE_VERSION: string;
 declare const NAME = "@etrepum/lexical-builder/emoji-plan";
 export interface EmojiPlanConfig {
+    /**
+     * The base URL to find the emoji PNG files, originally from the 64x64 set in emoji-datasource-facebook.
+     * Default: https://cdn.jsdelivr.net/npm/@etrepum/lexical-emoji-plan@${import.meta.env.PACKAGE_VERSION}/dist/emoji
+     *
+     * Do not add a trailing slash to the path.
+     */
     emojiBaseUrl: string;
+    /**
+     * The class to use for emoji nodes
+     */
     emojiClass: string;
+    /**
+     * The class to use for emoji nodes after the image is loaded and set as a background-image
+     */
     emojiLoadedClass: string;
 }
 declare module "@etrepum/lexical-builder" {
@@ -17,6 +29,20 @@ declare module "@etrepum/lexical-builder" {
         [NAME]: typeof EmojiPlan;
     }
 }
+/**
+ * A plan to use the emoji-datasource-facebook emoji database to convert
+ * short names such as :man-facepalming: or :) to their corresponding
+ * emoji, and uses an img from the same package rather than the current
+ * font to display it so that the display is consistent regardless of the
+ * platform.
+ *
+ * Loading the emoji database is done using an async import so will typicallly
+ * be a lazy loaded module in a separate chunk.
+ *
+ * Images are also maximally lazily loaded, before they load the font's
+ * representation of that emoji is used and then the emojiLoadedClass is
+ * added.
+ */
 export declare const EmojiPlan: import('@etrepum/lexical-builder').LexicalPlan<EmojiPlanConfig, "@etrepum/lexical-builder/emoji-plan">;
 export {};
 //# sourceMappingURL=EmojiPlan.d.ts.map

package/dist/EmojiPlan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EmojiPlan.d.ts","sourceRoot":"","sources":["../src/EmojiPlan.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAQH,eAAO,MAAM,eAAe,EAAE,MAAwC,CAAC;AAEvE,QAAA,MAAM,IAAI,wCAAwC,CAAC;AACnD,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,OAAO,QAAQ,0BAA0B,CAAC;IACxC,UAAU,mBAAmB;QAC3B,CAAC,IAAI,CAAC,EAAE,OAAO,SAAS,CAAC;KAC1B;CACF;AAED,eAAO,MAAM,SAAS,wGA8CpB,CAAC"}
+{"version":3,"file":"EmojiPlan.d.ts","sourceRoot":"","sources":["../src/EmojiPlan.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAQH,eAAO,MAAM,eAAe,EAAE,MAAwC,CAAC;AAEvE,QAAA,MAAM,IAAI,wCAAwC,CAAC;AACnD,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,OAAO,QAAQ,0BAA0B,CAAC;IACxC,UAAU,mBAAmB;QAC3B,CAAC,IAAI,CAAC,EAAE,OAAO,SAAS,CAAC;KAC1B;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS,wGAmEpB,CAAC"}

package/dist/_textNodeTransform-CSOyqRcv.js

@@ -0,0 +1,20 @@
+import { f as r, $ as n } from "./index-DE5LwTx8.js";
+function l(e) {
+  if (!e.isSimpleText() || e.hasFormat("code"))
+    return;
+  const i = e.getTextContent(), t = r(i);
+  if (t === null)
+    return;
+  let o;
+  t.position === 0 ? [o] = e.splitText(
+    t.position + t.shortcode.length
+  ) : [, o] = e.splitText(
+    t.position,
+    t.position + t.shortcode.length
+  );
+  const s = n(t.emoji);
+  o.replace(s);
+}
+export {
+  l as $textNodeTransform
+};

package/dist/findEmoji.d.ts

@@ -5,13 +5,47 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
+/**
+ * The location of the emoji match in the given text
+ */
 export type EmojiMatch = Readonly<{
+    /** The start position of the text */
     position: number;
+    /** The matching shortcode from the text, such as ":man-facepalming:" or ":)" */
     shortcode: string;
+    /** The text of the emoji from the database, such as "🤦‍♂️" or "🙂" */
     emoji: string;
 }>;
 /**
- * Finds emoji shortcodes in text and if found - returns its position in text, matched shortcode and unified ID
+ * Finds emoji shortcodes in text, tokenized by spaces. The canonical short
+ * names such as ":smiley:" are matched even if they are at the end of the
+ * text, but a text such as ":)" is only matched if it is followed by a
+ * space.
+ *
+ * @example Matching canonical short names
+ * ```js
+ * const result =
+ * assert(findEmoji(":man-facepalming").emoji === "🤦‍♂️");
+ * ```
+ *
+ * @example Matching non-canonical text for an emoji
+ * ```js
+ * const input = "handles :) mid-string";
+ * const result = findEmoji(input);
+ * assert(result.position === "handles ".length);
+ * assert(result.shortcode === ":)")
+ * assert(result.emoji === "🙂");
+ * assert([
+ *   input.slice(0, result.position),
+ *   result.emoji,
+ *   input.slice(result.position + result.shortcode.length)
+ * ].join("") === "handles 🙂 mid-string");
+ * ```
+ *
+ * @example Non-canonical text does not match at the end
+ * ```js
+ * assert(findEmoji(":)") === null)
+ * ```
  */
-export default function findEmoji(text: string): EmojiMatch | null;
+export declare function findEmoji(text: string): EmojiMatch | null;
 //# sourceMappingURL=findEmoji.d.ts.map

package/dist/findEmoji.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"findEmoji.d.ts","sourceRoot":"","sources":["../src/findEmoji.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC,CAAC;AAiBH;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAqBjE"}
+{"version":3,"file":"findEmoji.d.ts","sourceRoot":"","sources":["../src/findEmoji.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC;IAChC,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;CACf,CAAC,CAAC;AAiBH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAqBzD"}

package/dist/{_textNodeTransform-B5xhH7gd.js → index-DE5LwTx8.js}

@@ -1,5 +1,85 @@
-import { $ as i } from "./index-BH2QLn55.js";
-const _ = `🀄 mahjong
+import { definePlan as h, safeCast as p } from "@etrepum/lexical-builder";
+import { mergeRegister as m } from "@lexical/utils";
+import { TextNode as f } from "lexical";
+class t extends f {
+  static getType() {
+    return "emoji";
+  }
+  static clone(n) {
+    return new t(n.__text, n.__key);
+  }
+  static importJSON(n) {
+    return u(n.text);
+  }
+  exportJSON() {
+    return {
+      ...super.exportJSON(),
+      type: "emoji"
+    };
+  }
+}
+function u(a) {
+  return new t(a).setMode("token");
+}
+function z(a) {
+  return String.fromCodePoint(
+    ...a.split("-").map((n) => parseInt(n, 16))
+  );
+}
+function b(a) {
+  return Array.from(
+    a,
+    (n) => n.codePointAt(0).toString(16).padStart(4, "0")
+  ).join("-");
+}
+const w = "@etrepum/lexical-builder/emoji-plan", q = h({
+  config: p({
+    emojiBaseUrl: "https://cdn.jsdelivr.net/npm/@etrepum/lexical-emoji-plan@0.0.13/dist/emoji",
+    emojiClass: "emoji-node",
+    emojiLoadedClass: "emoji-node-loaded"
+  }),
+  name: w,
+  nodes: [t],
+  register(a, n, r) {
+    const e = /* @__PURE__ */ new Map();
+    let o = m(
+      a.registerMutationListener(t, (l) => {
+        for (const [_, d] of l)
+          if (d === "destroyed") {
+            const i = e.get(_);
+            i && (e.delete(_), i());
+          } else {
+            const i = a.getElementByKey(_);
+            if (i) {
+              const g = `${n.emojiBaseUrl}/${b(i.innerText)}.png`;
+              i.classList.add(n.emojiClass), i.style.backgroundImage = `url(${g})`;
+              const s = new Image(), c = () => {
+                i.classList.add(n.emojiLoadedClass), e.delete(_);
+              };
+              e.set(
+                _,
+                () => s.removeEventListener("load", c)
+              ), s.addEventListener("load", c, {
+                signal: r.signal,
+                once: !0
+              }), s.src = g;
+            }
+          }
+      }),
+      () => {
+        for (const l of e.values())
+          l();
+        e.clear();
+      }
+    );
+    return import("./_textNodeTransform-CSOyqRcv.js").then(({ $textNodeTransform: l }) => {
+      r.signal.aborted || (o = m(
+        o,
+        a.registerNodeTransform(f, l)
+      ));
+    }), () => o();
+  }
+}), k = `🀄 mahjong
 🃏 black_joker
 🅰️ a
 🅱️ b
@@ -1849,47 +1929,35 @@ const _ = `🀄 mahjong
 〰️ wavy_dash
 〽️ part_alternation_mark
 ㊗️ congratulations
-㊙️ secret`, t = _.split(`
-`).reduce((a, l) => {
-  const [n, e, ...o] = l.split(" ");
-  a.set(`:${e}:`, n);
-  for (const r of o)
-    a.set(r, n);
+㊙️ secret`, y = k.split(`
+`).reduce((a, n) => {
+  const [r, e, ...o] = n.split(" ");
+  a.set(`:${e}:`, r);
+  for (const l of o)
+    a.set(l, r);
   return a;
 }, /* @__PURE__ */ new Map());
-function s(a) {
-  const l = a.split(" ");
-  for (let n = 0, e = 0; n < l.length; n++) {
-    const o = l[n], r = t.get(o);
-    if (r && // only consider matches for the unique :shortname: unless it's not at the
+function E(a) {
+  const n = a.split(" ");
+  for (let r = 0, e = 0; r < n.length; r++) {
+    const o = n[r], l = y.get(o);
+    if (l && // only consider matches for the unique :shortname: unless it's not at the
     // end of the text. This avoids having smileys taking precedence over
     // emoji with longer names (e.g. :b vs. :bear: or :p vs. :pig:)
     (a.length > e + o.length || o.endsWith(":")))
       return {
         position: e,
         shortcode: o,
-        emoji: r
+        emoji: l
       };
     e += o.length + 1;
   }
   return null;
 }
-function c(a) {
-  if (!a.isSimpleText() || a.hasFormat("code"))
-    return;
-  const l = a.getTextContent(), n = s(l);
-  if (n === null)
-    return;
-  let e;
-  n.position === 0 ? [e] = a.splitText(
-    n.position + n.shortcode.length
-  ) : [, e] = a.splitText(
-    n.position,
-    n.position + n.shortcode.length
-  );
-  const o = i(n.emoji);
-  e.replace(o);
-}
 export {
-  c as $textNodeTransform
+  u as $,
+  q as E,
+  E as f,
+  z as t,
+  b as u
 };

package/dist/index.d.ts

@@ -1,2 +1,4 @@
 export { EmojiPlan, type EmojiPlanConfig } from './EmojiPlan';
+export { unifiedIDFromText, textFromUnifiedID } from './unifiedID';
+export { findEmoji, type EmojiMatch } from './findEmoji';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -1,4 +1,7 @@
-import { E as m } from "./index-BH2QLn55.js";
+import { E as a, f as e, t as f, u as m } from "./index-DE5LwTx8.js";
 export {
-  m as EmojiPlan
+  a as EmojiPlan,
+  e as findEmoji,
+  f as textFromUnifiedID,
+  m as unifiedIDFromText
 };

package/dist/supportedEmojis.data.d.ts

@@ -1,6 +1,9 @@
 /**
- * We rewrite the emoji dataset into plain text, which serializes smaller and
- * is quicker to parse
+ * We rewrite the emoji dataset into plain text delimited by
+ * spaces and newlines, which serializes smaller and is quicker to parse.
+ *
+ * This is done at build time by vite-plugin-data, which does compile-time
+ * evaluation of modules with .data in their name.
  */
 export declare const supportedEmojis: string;
 //# sourceMappingURL=supportedEmojis.data.d.ts.map

package/dist/supportedEmojis.data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"supportedEmojis.data.d.ts","sourceRoot":"","sources":["../src/supportedEmojis.data.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,eAAe,QAYf,CAAC"}
+{"version":3,"file":"supportedEmojis.data.d.ts","sourceRoot":"","sources":["../src/supportedEmojis.data.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,QAYf,CAAC"}

package/dist/unifiedID.d.ts

@@ -1,3 +1,22 @@
+/**
+ * Convert a unified emoji ID its emoji representation.
+ *
+ * @example
+ * ```js
+ * assert(textFromUnifiedId("1F926-200D-2642-FE0F") === "🤦‍♂️");
+ * ```
+ *
+ * @param unifiedID The hyphen delimited hex representation of the UTF-16 code points in the emoji
+ * @returns The emoji as a string
+ */
 export declare function textFromUnifiedID(unifiedID: string): string;
+/**
+ * Convert an emoji to its unified id (in uppercase).
+ *
+ * @example
+ * ```js
+ * assert(unifiedIDFromText("🤦‍♂️") === "1F926-200D-2642-FE0F");
+ * ```
+ */
 export declare function unifiedIDFromText(text: string): string;
 //# sourceMappingURL=unifiedID.d.ts.map

package/dist/unifiedID.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unifiedID.d.ts","sourceRoot":"","sources":["../src/unifiedID.ts"],"names":[],"mappings":"AAAA,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAItD"}
+{"version":3,"file":"unifiedID.d.ts","sourceRoot":"","sources":["../src/unifiedID.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAItD"}

package/package.json

@@ -15,7 +15,7 @@
     "test": "vitest run",
     "test:watch": "vitest"
   },
-  "version": "0.0.13-nightly.20240605.0",
+  "version": "0.0.13",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -28,7 +28,6 @@
   "homepage": "https://github.com/etrepum/lexical-builder",
   "dependencies": {
     "@etrepum/lexical-builder": "*",
-    "@repo/typescript-config": "*",
     "emoji-datasource-facebook": "15.1.2"
   },
   "peerDependencies": {

package/dist/index-BH2QLn55.js

@@ -1,66 +0,0 @@
-import { definePlan as p, safeCast as u } from "@etrepum/lexical-builder";
-import { mergeRegister as g } from "@lexical/utils";
-import { TextNode as d } from "lexical";
-class r extends d {
-  static getType() {
-    return "emoji";
-  }
-  static clone(e) {
-    return new r(e.__text, e.__key);
-  }
-  static importJSON(e) {
-    return j(e.text);
-  }
-  exportJSON() {
-    return {
-      ...super.exportJSON(),
-      type: "emoji"
-    };
-  }
-}
-function j(t) {
-  return new r(t).setMode("token");
-}
-function f(t) {
-  return Array.from(
-    t,
-    (e) => e.codePointAt(0).toString(16).padStart(4, "0")
-  ).join("-");
-}
-const x = "@etrepum/lexical-builder/emoji-plan", L = p({
-  config: u({
-    emojiBaseUrl: "https://cdn.jsdelivr.net/npm/@etrepum/lexical-emoji-plan@0.0.13-nightly.20240605.0/dist/emoji",
-    emojiClass: "emoji-node",
-    emojiLoadedClass: "emoji-node-loaded"
-  }),
-  name: x,
-  nodes: [r],
-  register(t, e, s) {
-    let n = t.registerMutationListener(r, (i) => {
-      for (const [l, c] of i)
-        if (c !== "destroyed") {
-          const o = t.getElementByKey(l);
-          if (o) {
-            const a = `${e.emojiBaseUrl}/${f(o.innerText)}.png`;
-            o.classList.add(e.emojiClass), o.style.backgroundImage = `url(${a})`;
-            const m = new Image();
-            m.addEventListener(
-              "load",
-              () => o.classList.add(e.emojiLoadedClass),
-              { signal: s.signal, once: !0 }
-            ), m.src = a;
-          }
-        }
-    });
-    return import("./_textNodeTransform-B5xhH7gd.js").then(({ $textNodeTransform: i }) => {
-      s.signal.aborted || (n = g(
-        n,
-        t.registerNodeTransform(d, i)
-      ));
-    }), () => n();
-  }
-});
-export {
-  j as $,
-  L as E
-};