@ethora/chat-component 26.9.8 → 26.10.3

package/dist/helpers/viewerSender.d.ts

@@ -0,0 +1,47 @@
+/** What the media viewer knows about a sender, however thin. */
+export interface ViewerSenderInput {
+    id?: string;
+    username?: string;
+    /** `message.user.name`, which carries the display name for many senders. */
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    photo?: string;
+}
+interface DirectoryEntry {
+    firstName?: string;
+    lastName?: string;
+    profileImage?: string;
+}
+interface OwnProfile extends DirectoryEntry {
+    xmppUsername?: string;
+    name?: string;
+}
+export interface ResolveViewerSenderOptions {
+    sender?: ViewerSenderInput | null;
+    /** `rooms.usersSet`, keyed by the xmpp username. */
+    usersSet?: Record<string, DirectoryEntry | undefined>;
+    /** The signed-in user, for their own messages. */
+    me?: OwnProfile | null;
+    /** Only used for a 1:1 room, where the room is named after the peer. */
+    peerRoomName?: string;
+}
+export interface ResolvedViewerSender {
+    /** Empty when nobody could be named. The header then omits the name line. */
+    name: string;
+    photo?: string;
+}
+/**
+ * Resolves the sender shown in the viewer header. The order is the one the
+ * message bubble uses, with the signed-in user's own profile as the answer for
+ * their own messages (an own optimistic message often has no name on it):
+ *
+ *   first + last on the message, the message's own `name`, the profile in
+ *   `usersSet`, the signed-in user's profile (own messages), the username
+ *   before the `@`, and for a 1:1 room the room's name.
+ *
+ * Never returns a placeholder: when nothing is known `name` is '' and the
+ * caller draws a neutral glyph rather than initials.
+ */
+export declare const resolveViewerSender: ({ sender, usersSet, me, peerRoomName, }: ResolveViewerSenderOptions) => ResolvedViewerSender;
+export {};

package/dist/hooks/useAvatarImage.d.ts

@@ -0,0 +1,21 @@
+export type AvatarImageStatus = 'none' | 'loading' | 'loaded' | 'failed';
+/**
+ * Resolves an avatar URL for rendering. Never waits on the network: the
+ * caller shows initials immediately and fades the <img> in once `status` is
+ * `loaded`.
+ *
+ *  - appends the viewer's `?ft=` token for secure-files URLs synchronously
+ *    from the store (no token round trip before the request starts);
+ *  - reuses a URL that already loaded for the same file (see
+ *    avatarImageCache) so a token rotation or a second component showing the
+ *    same person does not trigger another download;
+ *  - skips URLs that just failed (no repeated failing requests);
+ *  - on a secure-file failure kicks the throttled fileToken recovery, whose
+ *    refreshed token yields a new URL and therefore a new attempt.
+ */
+export declare const useAvatarImage: (rawSrc: string | null | undefined) => {
+    src: string;
+    status: AvatarImageStatus;
+    onLoad: () => void;
+    onError: () => void;
+};

package/dist/hooks/useIsMobileViewport.d.ts

@@ -1 +1,6 @@
 export declare const useIsMobileViewport: (breakpoint?: number) => boolean;
+/**
+ * Non-hook form of the same check, for event handlers that need the answer
+ * at the moment of the event rather than as render state.
+ */
+export declare const isMobileViewportNow: (breakpoint?: number) => boolean;

package/dist/hooks/useMediaProbe.d.ts

@@ -0,0 +1,41 @@
+export type MediaProbeStatus = 'idle' | 'loading' | 'recovering' | 'loaded' | 'error';
+export interface MediaProbe {
+    status: MediaProbeStatus;
+    /**
+     * Natural size. Known once `status` is 'loaded', and usually sooner: it is
+     * read from the first decoded header while the bytes are still arriving.
+     */
+    width: number;
+    height: number;
+    /**
+     * The URL whose bytes are on screen. While a picture is shown, a rotated
+     * `?ft=` token does not swap it for a fresh request: the URL that loaded
+     * stays, so a token refresh never blanks or re-downloads what is visible.
+     */
+    url: string;
+}
+/**
+ * No byte of the file (not even its header) arrived in this long: stop
+ * waiting and show the unavailable state with a manual retry. Once the size
+ * is known the file is on its way and is never cut off by this timer.
+ */
+export declare const MEDIA_STALL_MS = 8000;
+export declare const resetMediaProbeCaches: () => void;
+/**
+ * Preloads one image off-DOM so the visible <img> only mounts once its bytes
+ * are cached.
+ *
+ * A failure never says anything about the file being deleted: a 404 from the
+ * storage host, an expired token, a CORS or DNS hiccup and a dead CDN edge all
+ * fail an <img> the same way, and the server's answer cannot be read across
+ * origins anyway. So the only outcome is the 'error' state, which the surface
+ * offers to `retry`. Deleting a message is driven by the server (a delete
+ * stanza) or by the sender's own Files panel action, never inferred here.
+ *
+ * A secure URL that fails gets at most one shared token refresh per token
+ * (see `requestFileTokenRecovery`); the refreshed URL re-runs this effect.
+ */
+export declare const useMediaProbe: (url: string | undefined) => MediaProbe & {
+    retry: () => void;
+    fail: () => void;
+};

package/dist/hooks/usePaneWidthVar.d.ts

@@ -0,0 +1,11 @@
+import { RefObject } from 'react';
+/**
+ * Publishes the width of an element as the `--ethora-pane-w` custom property
+ * on that element, so message media can size itself to the chat pane (which
+ * may be a narrow host) instead of the viewport. Updated on every resize.
+ *
+ * The element may mount after the first render (the list shows a loader
+ * first), so every commit checks whether the ref points at a new element
+ * and re-attaches the observer if so.
+ */
+export declare const usePaneWidthVar: (ref: RefObject<HTMLElement | null>) => void;

package/dist/hooks/usePdfThumbnail.d.ts

@@ -15,7 +15,6 @@ interface UsePdfThumbnailResult {
     status: PdfThumbnailStatus;
     /** Object URL - owned by this hook, revoked on unmount/url change. */
     thumbnailUrl?: string;
-    pageCount?: number;
     /** Re-runs a render that failed or was skipped for being too big. */
     retry: () => void;
 }

package/dist/hooks/usePrefersReducedMotion.d.ts

@@ -0,0 +1,2 @@
+/** True while the user asks the OS for reduced motion; follows live changes. */
+export declare const usePrefersReducedMotion: () => boolean;

package/dist/hooks/useRoomInitialization.d.ts

@@ -1,2 +1,2 @@
-import { IConfig, IRoom } from '../types/types';
-export declare const useRoomInitialization: (activeRoomJID: string, roomsList: Record<string, IRoom>, config: IConfig, messageLength: number) => void;
+import { IConfig } from '../types/types';
+export declare const useRoomInitialization: (activeRoomJID: string, config: IConfig, messageLength: number) => void;

package/dist/hooks/useRoomUrl.d.ts

@@ -1,2 +1,2 @@
-import { IConfig, IRoom } from '../types/types';
-export declare const useRoomUrl: (activeRoomJID: string, roomsList: Record<string, IRoom>, config: IConfig) => void;
+import { IConfig } from '../types/types';
+export declare const useRoomUrl: (activeRoomJID: string, config: IConfig) => void;

package/dist/hooks/useSendMessage.d.ts

@@ -1,8 +1,11 @@
 import { IMentionSpan } from '../types/types';
+import { CaptionInput } from '../helpers/caption';
+/** Files of one message uploaded at the same time. */
+export declare const MEDIA_UPLOAD_CONCURRENCY = 4;
 export { shouldTagOutgoingTranslateSource } from '../utils/translateModePolicy';
 export declare const useSendMessage: () => {
     sendMessage: (message: string, activeRoomJID: string, isReply?: boolean, isChecked?: boolean, mainMessage?: string, mentions?: IMentionSpan[]) => Promise<void>;
-    sendMedia: (data: File | File[] | Blob, type: string, activeRoomJID: string, isReply?: boolean, isChecked?: boolean, mainMessage?: string) => Promise<void>;
+    sendMedia: (data: File | File[] | Blob, type: string, activeRoomJID: string, isReply?: boolean, isChecked?: boolean, mainMessage?: string, caption?: CaptionInput) => Promise<boolean>;
     sendEditMessage: (message: string) => Promise<void>;
     isLastMessageFromUserAndProcessing: (roomJID: string) => boolean;
 };