@poolse/react 2.27.0 → 2.28.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { PoolseConfig, Poolse, Me, Uuid, Conversation, ConversationCreateRequest, Membership, MemberRole, Message, MessageCreateRequest, RealtimeStatus, Attachment, AttachmentUploadInput, PoolseUserProfile, CallRoomStatus, CallParticipant, CameraFacing, CallDeviceKind, CallDevice, LiveKitModule, VoiceStatus, VoiceParticipant, VoiceRoomOptions, IncomingCall, OutgoingCall, CallMedia, LiveCall } from '@poolse/sdk';
-export { ApiError, Attachment, AttachmentStatus, AttachmentUploadInput, AttachmentUploadRequest, AttachmentUploadResponse, AuthError, CallEndReason, CallLog, CallLogDisplay, CallLogEntry, CallLogMedia, CallMissedEntry, CallParticipantStatus, Conversation, ConversationCreateRequest, DeviceKind, LiveCall, LiveCallMember, Me, MemberRole, Membership, Message, MessageCreateRequest, MessageType, NetworkError, PoolseConfig, PoolseError, PoolseUserProfile, RateLimitedError, ReadReceiptsState, RealtimeStatus, Uuid, callLogDisplayFor, describeCallLog, formatCallDuration, formatCallLogPreview, isCallLogMessage, isMessageVisibleTo, parseCallLog, parseCallLogBody } from '@poolse/sdk';
+export { ApiError, Attachment, AttachmentStatus, AttachmentUploadInput, AttachmentUploadRequest, AttachmentUploadResponse, AuthError, CallEndReason, CallLog, CallLogDisplay, CallLogEntry, CallLogMedia, CallMissedEntry, CallParticipantStatus, Conversation, ConversationCreateRequest, DeviceKind, LiveCall, LiveCallMember, Me, MemberRole, Membership, Message, MessageCreateRequest, MessageType, NetworkError, PoolseConfig, PoolseError, PoolseUserProfile, RateLimitedError, ReadReceiptsState, RealtimeStatus, RoomSession, Uuid, callLogDisplayFor, describeCallLog, formatCallDuration, formatCallLogPreview, isCallLogMessage, isMessageVisibleTo, parseCallLog, parseCallLogBody } from '@poolse/sdk';
 import { ReactNode } from 'react';
 
 interface PoolseProviderProps {
@@ -783,6 +783,51 @@ interface UseLiveCall {
  */
 declare function useLiveCall(conversationId: string | null): UseLiveCall;
 
+interface UseRoomOptions {
+    /** `livekit-client`, imported by your app: `import * as livekit from 'livekit-client'`. */
+    livekit: LiveKitModule;
+}
+interface UseRoom {
+    /**
+     * The room (or call) running on the conversation right now, whether
+     * or not this user is in it — what a "Join" button reads.
+     */
+    live: ReturnType<typeof useLiveCall>['call'];
+    /** User ids in the room at this moment. */
+    presentIds: string[];
+    /** This user is in (or connecting to) the room. */
+    joined: boolean;
+    /** Starting or joining is in flight. */
+    joining: boolean;
+    /**
+     * Drop in: starts the conversation's room if none is live, or joins
+     * the one that is (a ringing call included). Nobody's phone rings.
+     * `video` turns the camera on as you arrive. `{ ring: true }` rings
+     * the other members' phones as well — an opt-in for apps where web
+     * calls people (a support desk); rooms never ring otherwise.
+     */
+    join: (media?: 'audio' | 'video', opts?: {
+        ring?: boolean;
+    }) => Promise<void>;
+    /** Leave. The room carries on for whoever is still in it. */
+    leave: () => void;
+    /** The media side: participants, mic/camera, devices (see `useCallRoom`). */
+    media: UseCallRoom;
+    error: Error | null;
+}
+/**
+ * A conversation's room — Meet-style: anyone in the conversation drops
+ * in for voice or video while the chat carries on, and nothing rings.
+ *
+ *     const room = useRoom(conversationId, { livekit });
+ *     room.live ? <button onClick={() => room.join()}>Join</button>
+ *               : <button onClick={() => room.join('video')}>Start a video room</button>;
+ *
+ * The room ends on its own once it has been empty for a short while,
+ * and leaves one line in the conversation's history.
+ */
+declare function useRoom(conversationId: string | null, opts: UseRoomOptions): UseRoom;
+
 interface UseReadReceipts {
     /**
      * Whether this user sees other people's read state. False → show no
@@ -822,4 +867,4 @@ declare function canEditOwnMessage(args: {
     now?: number;
 }): boolean;
 
-export { type CallPhase, EDIT_WINDOW_MS, type GroupPosition, PoolseProvider, type PoolseProviderProps, type ReactionMap, type UploadItem, type UploadItemStatus, type UseCallRoom, type UseCallRoomOptions, type UseCalls, type UseLiveCall, type UseReadReceipts, type UseUserState, type UseVoiceRoom, canEditOwnMessage, computeGroupPosition, formatDayLabel, receiptsOf, sameDay, sameGroup, useAttachmentUpload, useAttachmentUrl, useCallRoom, useCalls, useConversation, useConversations, useLiveCall, useMe, useMembers, useMessages, usePoolse, usePresence, useReactions, useReadReceipts, useRealtimeStatus, useThread, useTyping, useUser, useVoiceRoom };
+export { type CallPhase, EDIT_WINDOW_MS, type GroupPosition, PoolseProvider, type PoolseProviderProps, type ReactionMap, type UploadItem, type UploadItemStatus, type UseCallRoom, type UseCallRoomOptions, type UseCalls, type UseLiveCall, type UseReadReceipts, type UseRoom, type UseRoomOptions, type UseUserState, type UseVoiceRoom, canEditOwnMessage, computeGroupPosition, formatDayLabel, receiptsOf, sameDay, sameGroup, useAttachmentUpload, useAttachmentUrl, useCallRoom, useCalls, useConversation, useConversations, useLiveCall, useMe, useMembers, useMessages, usePoolse, usePresence, useReactions, useReadReceipts, useRealtimeStatus, useRoom, useThread, useTyping, useUser, useVoiceRoom };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { PoolseConfig, Poolse, Me, Uuid, Conversation, ConversationCreateRequest, Membership, MemberRole, Message, MessageCreateRequest, RealtimeStatus, Attachment, AttachmentUploadInput, PoolseUserProfile, CallRoomStatus, CallParticipant, CameraFacing, CallDeviceKind, CallDevice, LiveKitModule, VoiceStatus, VoiceParticipant, VoiceRoomOptions, IncomingCall, OutgoingCall, CallMedia, LiveCall } from '@poolse/sdk';
-export { ApiError, Attachment, AttachmentStatus, AttachmentUploadInput, AttachmentUploadRequest, AttachmentUploadResponse, AuthError, CallEndReason, CallLog, CallLogDisplay, CallLogEntry, CallLogMedia, CallMissedEntry, CallParticipantStatus, Conversation, ConversationCreateRequest, DeviceKind, LiveCall, LiveCallMember, Me, MemberRole, Membership, Message, MessageCreateRequest, MessageType, NetworkError, PoolseConfig, PoolseError, PoolseUserProfile, RateLimitedError, ReadReceiptsState, RealtimeStatus, Uuid, callLogDisplayFor, describeCallLog, formatCallDuration, formatCallLogPreview, isCallLogMessage, isMessageVisibleTo, parseCallLog, parseCallLogBody } from '@poolse/sdk';
+export { ApiError, Attachment, AttachmentStatus, AttachmentUploadInput, AttachmentUploadRequest, AttachmentUploadResponse, AuthError, CallEndReason, CallLog, CallLogDisplay, CallLogEntry, CallLogMedia, CallMissedEntry, CallParticipantStatus, Conversation, ConversationCreateRequest, DeviceKind, LiveCall, LiveCallMember, Me, MemberRole, Membership, Message, MessageCreateRequest, MessageType, NetworkError, PoolseConfig, PoolseError, PoolseUserProfile, RateLimitedError, ReadReceiptsState, RealtimeStatus, RoomSession, Uuid, callLogDisplayFor, describeCallLog, formatCallDuration, formatCallLogPreview, isCallLogMessage, isMessageVisibleTo, parseCallLog, parseCallLogBody } from '@poolse/sdk';
 import { ReactNode } from 'react';
 
 interface PoolseProviderProps {
@@ -783,6 +783,51 @@ interface UseLiveCall {
  */
 declare function useLiveCall(conversationId: string | null): UseLiveCall;
 
+interface UseRoomOptions {
+    /** `livekit-client`, imported by your app: `import * as livekit from 'livekit-client'`. */
+    livekit: LiveKitModule;
+}
+interface UseRoom {
+    /**
+     * The room (or call) running on the conversation right now, whether
+     * or not this user is in it — what a "Join" button reads.
+     */
+    live: ReturnType<typeof useLiveCall>['call'];
+    /** User ids in the room at this moment. */
+    presentIds: string[];
+    /** This user is in (or connecting to) the room. */
+    joined: boolean;
+    /** Starting or joining is in flight. */
+    joining: boolean;
+    /**
+     * Drop in: starts the conversation's room if none is live, or joins
+     * the one that is (a ringing call included). Nobody's phone rings.
+     * `video` turns the camera on as you arrive. `{ ring: true }` rings
+     * the other members' phones as well — an opt-in for apps where web
+     * calls people (a support desk); rooms never ring otherwise.
+     */
+    join: (media?: 'audio' | 'video', opts?: {
+        ring?: boolean;
+    }) => Promise<void>;
+    /** Leave. The room carries on for whoever is still in it. */
+    leave: () => void;
+    /** The media side: participants, mic/camera, devices (see `useCallRoom`). */
+    media: UseCallRoom;
+    error: Error | null;
+}
+/**
+ * A conversation's room — Meet-style: anyone in the conversation drops
+ * in for voice or video while the chat carries on, and nothing rings.
+ *
+ *     const room = useRoom(conversationId, { livekit });
+ *     room.live ? <button onClick={() => room.join()}>Join</button>
+ *               : <button onClick={() => room.join('video')}>Start a video room</button>;
+ *
+ * The room ends on its own once it has been empty for a short while,
+ * and leaves one line in the conversation's history.
+ */
+declare function useRoom(conversationId: string | null, opts: UseRoomOptions): UseRoom;
+
 interface UseReadReceipts {
     /**
      * Whether this user sees other people's read state. False → show no
@@ -822,4 +867,4 @@ declare function canEditOwnMessage(args: {
     now?: number;
 }): boolean;
 
-export { type CallPhase, EDIT_WINDOW_MS, type GroupPosition, PoolseProvider, type PoolseProviderProps, type ReactionMap, type UploadItem, type UploadItemStatus, type UseCallRoom, type UseCallRoomOptions, type UseCalls, type UseLiveCall, type UseReadReceipts, type UseUserState, type UseVoiceRoom, canEditOwnMessage, computeGroupPosition, formatDayLabel, receiptsOf, sameDay, sameGroup, useAttachmentUpload, useAttachmentUrl, useCallRoom, useCalls, useConversation, useConversations, useLiveCall, useMe, useMembers, useMessages, usePoolse, usePresence, useReactions, useReadReceipts, useRealtimeStatus, useThread, useTyping, useUser, useVoiceRoom };
+export { type CallPhase, EDIT_WINDOW_MS, type GroupPosition, PoolseProvider, type PoolseProviderProps, type ReactionMap, type UploadItem, type UploadItemStatus, type UseCallRoom, type UseCallRoomOptions, type UseCalls, type UseLiveCall, type UseReadReceipts, type UseRoom, type UseRoomOptions, type UseUserState, type UseVoiceRoom, canEditOwnMessage, computeGroupPosition, formatDayLabel, receiptsOf, sameDay, sameGroup, useAttachmentUpload, useAttachmentUrl, useCallRoom, useCalls, useConversation, useConversations, useLiveCall, useMe, useMembers, useMessages, usePoolse, usePresence, useReactions, useReadReceipts, useRealtimeStatus, useRoom, useThread, useTyping, useUser, useVoiceRoom };

package/dist/index.js

@@ -1666,6 +1666,55 @@ function useLiveCall(conversationId) {
   }, [chat, conversationId, apply, refresh]);
   return { call, participantIds, refresh };
 }
+function useRoom(conversationId, opts) {
+  const poolse = usePoolse();
+  const { call: live, participantIds } = useLiveCall(conversationId);
+  const media = useCallRoom(conversationId, { livekit: opts.livekit, aloneGraceMs: 0 });
+  const session = useRef(null);
+  const [joining, setJoining] = useState(false);
+  const [error, setError] = useState(null);
+  useEffect(() => {
+    session.current = null;
+    setError(null);
+  }, [conversationId]);
+  const join = useCallback(
+    async (kind = "audio", joinOpts = {}) => {
+      if (!conversationId) return;
+      setJoining(true);
+      setError(null);
+      try {
+        session.current = joinOpts.ring ? await poolse.rooms.ring(conversationId, kind) : await poolse.rooms.start(conversationId, kind);
+        const connected = await media.join();
+        if (!connected) throw new Error("Rooms need the SFU, which this deployment does not have.");
+        if (kind === "video") await media.setCameraEnabled(true);
+      } catch (err) {
+        setError(err instanceof Error ? err : new Error(String(err)));
+        media.leave();
+      } finally {
+        setJoining(false);
+      }
+    },
+    [poolse, conversationId, media]
+  );
+  const leave = useCallback(() => {
+    media.leave();
+    const s = session.current;
+    session.current = null;
+    if (s) void poolse.rooms.leave(s).catch(() => {
+    });
+  }, [poolse, media]);
+  const joined = media.status === "connected" || media.status === "connecting" || joining;
+  return {
+    live,
+    presentIds: participantIds,
+    joined,
+    joining,
+    join,
+    leave,
+    media,
+    error: error ?? media.error
+  };
+}
 function useReadReceipts() {
   const chat = usePoolse();
   const { me } = useMe();
@@ -1695,6 +1744,6 @@ function canEditOwnMessage(args) {
   return Number.isFinite(sent) && (args.now ?? Date.now()) - sent < EDIT_WINDOW_MS;
 }
 
-export { EDIT_WINDOW_MS, PoolseProvider, canEditOwnMessage, computeGroupPosition, formatDayLabel, receiptsOf, sameDay, sameGroup, useAttachmentUpload, useAttachmentUrl, useCallRoom, useCalls, useConversation, useConversations, useLiveCall, useMe, useMembers, useMessages, usePoolse, usePresence, useReactions, useReadReceipts, useRealtimeStatus, useThread, useTyping, useUser, useVoiceRoom };
+export { EDIT_WINDOW_MS, PoolseProvider, canEditOwnMessage, computeGroupPosition, formatDayLabel, receiptsOf, sameDay, sameGroup, useAttachmentUpload, useAttachmentUrl, useCallRoom, useCalls, useConversation, useConversations, useLiveCall, useMe, useMembers, useMessages, usePoolse, usePresence, useReactions, useReadReceipts, useRealtimeStatus, useRoom, useThread, useTyping, useUser, useVoiceRoom };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map