@agora-sdk/secure-chat-core 0.7.0 → 0.8.0

package/dist/esm/hooks/useSecureMessages.d.ts

@@ -1,23 +1,28 @@
 import { SecureMessageModel } from "../contract/index.js";
 import { GroupHandle, type SecureDecryptFailureReason } from "@agora-sdk/secure-chat-crypto";
+import { type MimiContent } from "../content/mimi-content.js";
+import { type RenderedContent } from "./message-fold.js";
 /**
  * Decryption outcome for a stored message:
- * - `ok` — decrypted + authenticated; `plaintext` is set.
- * - `pending` — not decryptable yet (no group handle, or the message's epoch is ahead of ours); it will
- *   be retried when the group advances. `plaintext` is null.
- * - `rejected` — fails closed: the MLS core rejected it (replay, over-window gap, bad auth, malformed,
- *   too-old epoch). NEVER retried; `plaintext` is null and `rejectedReason` says why.
+ * - `ok` — decrypted + authenticated + decoded; `content`/`mimi`/`contentHash` are set (unless it is a
+ *   folded mutation, which the list omits, or a reserved control frame, which is hidden).
+ * - `pending` — not decryptable yet (no handle, or epoch ahead). Retried when the group advances.
+ * - `rejected` — fails closed (replay/gap/bad-auth/malformed/too-old, or undecodable content). Never retried.
  */
 export type SecureMessageStatus = "ok" | "pending" | "rejected";
-/** A stored message paired with its decryption outcome. */
+/** A stored message paired with its decoded, folded content. */
 export interface DecryptedSecureMessage {
     /** The raw message row from the server (still holds the base64 ciphertext). */
     model: SecureMessageModel;
-    /** Decrypted text, or null when {@link DecryptedSecureMessage.status} is `pending` or `rejected`. */
-    plaintext: string | null;
-    /** Decryption outcome — drives fail-closed handling and what the UI renders. */
+    /** The Tier-2 projection (body/replyTo/editedAt/deleted/reactions), or `null` when not `ok`. */
+    content: RenderedContent | null;
+    /** The raw decoded `MimiContent` (power users), or `null` when not `ok`. */
+    mimi: MimiContent | null;
+    /** SHA-256 content-hash — reference this to reply/react/edit/delete — or `null` when not `ok`. */
+    contentHash: Uint8Array | null;
+    /** Decryption outcome. */
     status: SecureMessageStatus;
-    /** When `status` is `rejected`, why the MLS core refused the message. */
+    /** When `status` is `rejected`, why. */
     rejectedReason?: SecureDecryptFailureReason;
 }
 /** Options for {@link useSecureMessages}. */
@@ -29,7 +34,7 @@ export interface UseSecureMessagesOptions {
 }
 /** The state and actions returned by {@link useSecureMessages}. */
 export interface UseSecureMessagesValues {
-    /** Loaded messages, newest first, each with decrypted text when possible. */
+    /** Rendered messages (post/reply rows with folded reactions/edits/deletes), newest first. */
     messages: DecryptedSecureMessage[];
     /** True while a page load or refresh is in flight. */
     loading: boolean;
@@ -41,15 +46,21 @@ export interface UseSecureMessagesValues {
     loadMore: () => Promise<void>;
     /** Reload from the newest message, replacing the current list. */
     refresh: () => Promise<void>;
-    /** Encrypt + send a text message. Requires a resolvable group + sender device. */
+    /** Encrypt + send a text post. */
     sendMessage: (text: string) => Promise<void>;
+    /** Send a reply to the message with `targetHash` (its {@link DecryptedSecureMessage.contentHash}). */
+    reply: (targetHash: Uint8Array, text: string) => Promise<void>;
+    /** React to the message with `targetHash` using `token` (e.g. an emoji). */
+    react: (targetHash: Uint8Array, token: string) => Promise<void>;
+    /** Edit the message with `targetHash`, replacing its body with `text`. */
+    editMessage: (targetHash: Uint8Array, text: string) => Promise<void>;
+    /** Delete (tombstone) the message with `targetHash`. */
+    deleteMessage: (targetHash: Uint8Array) => Promise<void>;
+    /** Withdraw your reaction whose own content-hash is `reactionHash`. */
+    unreact: (reactionHash: Uint8Array) => Promise<void>;
 }
 /**
- * Load, decrypt, send, and live-receive messages in one secure conversation.
- *
- * Auto-resolves the MLS group handle (via `resolveGroup`) and the sender device id (from the
- * persisted device) unless overridden in `options`. Joins the conversation socket room for live
- * `secure:message` events.
+ * Load, decrypt, send, and live-receive MIMI-content messages in one secure conversation.
  *
  * @param conversationId - The conversation to read and send within.
  * @param options - {@link UseSecureMessagesOptions}.
@@ -57,8 +68,9 @@ export interface UseSecureMessagesValues {
  *
  * @example
  * ```tsx
- * const { messages, sendMessage } = useSecureMessages(conversationId);
+ * const { messages, sendMessage, react } = useSecureMessages(conversationId);
  * await sendMessage("hello 💜");
+ * await react(messages[0].contentHash!, "👍");
  * ```
  */
 export declare function useSecureMessages(conversationId: string, options?: UseSecureMessagesOptions): UseSecureMessagesValues;