@ethora/chat-component 26.5.6 → 26.5.8

package/dist/helpers/mamReactions.d.ts

@@ -0,0 +1,47 @@
+import { Element } from 'ltx';
+import { IMessage } from '../types/models/message.model';
+import { ReactionAction } from '../types/models/action.model';
+/**
+ * A reaction restored from the MAM archive whose target message is NOT in the
+ * same history page. It is handed back to the caller so it can be dispatched to
+ * the store (where a target loaded by an earlier page or a live stanza lives).
+ */
+export type DeferredReaction = ReactionAction;
+/** Normalised view of a single `<reactions xmlns="urn:xmpp:reactions:0">` stanza. */
+export interface ExtractedReaction {
+    /** Stanza id of the message the reaction targets (matches `IMessage.id`). */
+    messageId: string;
+    /** Full reactor JID, e.g. `<localpart>@xmpp.host/resource`. */
+    from: string;
+    /** Bare reactor id (`from` up to `@`); the key reactions are stored under. */
+    fromId: string;
+    /** Emoji shortcodes for this reactor; empty means the reactor cleared them. */
+    emoji: string[];
+    /** `<data senderFirstName=… senderLastName=…/>` attributes, if present. */
+    data: Record<string, string>;
+    /** Room JID derived from `<stanza-id by>` or the reactor JID. */
+    roomJID: string;
+}
+/**
+ * Pull the reaction details out of a forwarded MAM message that carries a
+ * `<reactions>` child. Returns null when the stanza is not a usable reaction
+ * (missing target id or reactor).
+ */
+export declare const extractMamReaction: (msg: Element) => ExtractedReaction | null;
+/**
+ * Apply MAM reaction stanzas to a freshly parsed history page.
+ *
+ * Reactions are archived in MAM as standalone `<reactions>` stanzas. The MAM
+ * fetch path bypasses the live `onReactionHistory` handler, so without this the
+ * reactions only ever existed for the live session and disappeared on refresh.
+ *
+ * Reactions whose target message is in this same page are merged directly onto
+ * the message object (so they are present the instant the page is stored).
+ * Reactions whose target is not in the page are returned as `deferred` for the
+ * caller to dispatch to the store (the target may live in an earlier page or
+ * have arrived live).
+ */
+export declare const applyMamReactions: (messages: IMessage[], reactionStanzas: Element[]) => {
+    messages: IMessage[];
+    deferred: DeferredReaction[];
+};