opensips-js-vue 0.1.41 → 0.1.43

package/library/index.d.ts

@@ -246,6 +246,8 @@ export declare const MSRP_EVT: {
     readonly MESSAGE: "m.conversation.message";
     readonly MEMBER: "m.conversation.member";
     readonly CLOSED: "m.conversation.closed";
+    readonly REOPEN: "m.conversation.reopen";
+    readonly DELETE: "m.conversation.delete";
     readonly SYNC: "m.sync";
     readonly UPLOAD_REQUEST: "m.upload.request";
     readonly UPLOAD_RESPONSE: "m.upload.response";
@@ -253,27 +255,48 @@ export declare const MSRP_EVT: {
     readonly FILE_ACCESS_RESPONSE: "m.file.access.response";
     readonly REACTION: "m.reaction";
     readonly TYPING: "m.typing";
+    readonly PRESENCE: "m.presence";
     readonly SENT: "m.sent";
     readonly DELIVERED: "m.delivered";
     readonly READ: "m.read";
+    readonly UNREAD: "m.unread";
     readonly FAILED: "m.failed";
     readonly SENDING: "m.sending";
 };
 
 declare type msrpConversationCreatedListener = (payload: {
-    conversationKey: string
     conversation: MSRPConversationState_2
 }) => void
 
-declare type msrpConversationRemovedListener = (payload: { conversationKey: string }) => void
+/**
+ * A conversation is addressed exclusively by its public numeric
+ * `conversation_id`. A stringified id is also accepted for convenience.
+ */
+export declare type MSRPConversationRef = number | string;
+
+declare type msrpConversationRemovedListener = (payload: {
+    conversation_id?: number
+}) => void
 
 export declare interface MSRPConversationState {
-    conversationKey: string
+    /**
+     * Public, stable numeric conversation identifier assigned by the backend.
+     * This is the only identifier exposed to application code — conversations
+     * are addressed exclusively by `conversation_id`.
+     */
+    conversation_id?: number
     creator: string | null
     members: Set<string>
     memberRoles: Map<string, MSRPMemberRole>
     currentUserRole: MSRPMemberRole
     currentUserStatus: MSRPMembership | null
+    /**
+     * Per-user read pointer (backend `last_read_message_id` in the current
+     * user's member state). `null` means the whole conversation is unread;
+     * an event_id means everything after that event is unread. Consumers
+     * derive the unread count from this pointer + the local timeline.
+     */
+    currentUserLastReadMessageId?: string | null
     state_events: { [key: string]: { [stateKey: string]: any } }
     created_at: number
     updated_at: number
@@ -281,12 +304,24 @@ export declare interface MSRPConversationState {
 }
 
 declare interface MSRPConversationState_2 {
-    conversationKey: string
+    /**
+     * Public, stable numeric conversation identifier assigned by the backend.
+     * This is the only identifier exposed to application code — conversations
+     * are addressed exclusively by `conversation_id`.
+     */
+    conversation_id?: number
     creator: string | null
     members: Set<string>
     memberRoles: Map<string, MSRPMemberRole_2>
     currentUserRole: MSRPMemberRole_2
     currentUserStatus: MSRPMembership_2 | null
+    /**
+     * Per-user read pointer (backend `last_read_message_id` in the current
+     * user's member state). `null` means the whole conversation is unread;
+     * an event_id means everything after that event is unread. Consumers
+     * derive the unread count from this pointer + the local timeline.
+     */
+    currentUserLastReadMessageId?: string | null
     state_events: { [key: string]: { [stateKey: string]: any } }
     created_at: number
     updated_at: number
@@ -294,11 +329,11 @@ declare interface MSRPConversationState_2 {
 }
 
 declare type msrpConversationUpdatedListener = (payload: {
-    conversationKey: string
+    conversation_id?: number
     patch: Partial<MSRPConversationState_2>
 }) => void
 
-declare type MSRPInitializingListener = (sessionId: string | undefined) => void
+declare type MSRPInitializingListener = (value: boolean) => void
 
 export declare type MSRPMemberRole = 'in_charge' | 'manager' | 'assigned'
 
@@ -324,10 +359,25 @@ declare class MSRPMessage {
 }
 
 declare type msrpMessageAddedListener = (payload: {
-    conversationKey: string
+    conversation_id?: number
     message: any
 }) => void
 
+declare type msrpMessageDeletedListener = (payload: {
+    conversation_id?: number
+    eventId: string
+    deletedBy: string
+    updatedAt: number
+}) => void
+
+declare type msrpMessageEditedListener = (payload: {
+    conversation_id?: number
+    eventId: string
+    newContent: any
+    editEvent: any
+    updatedAt: number
+}) => void
+
 export declare type MSRPMessageEventType = {
     message: MSRPMessage,
     session: MSRPSessionExtended_2
@@ -355,8 +405,28 @@ declare interface MSRPOptions_2 extends AnswerOptions {
     fromDisplayName?: string;
 }
 
+declare type msrpPresenceListener = (payload: {
+    conversation_id?: number
+    sender: string
+    presence: string | null
+    lastActiveAt: number | null
+    updatedAt: number
+}) => void
+
+/**
+ * Presence pulse for a peer, indexed by SIP URI. Values are pushed from
+ * `msrpPresence` events and consumed by presence dots / "last seen" UI.
+ */
+export declare interface MSRPPresenceState {
+    presence: string | null;
+    lastActiveAt: number | null;
+    updatedAt: number;
+}
+
+export declare type MSRPReactionAction = 'add' | 'remove';
+
 declare type msrpReactionChangedListener = (payload: {
-    conversationKey: string
+    conversation_id?: number
     eventId: string
     emoji: string
     action: 'add' | 'remove'
@@ -365,12 +435,22 @@ declare type msrpReactionChangedListener = (payload: {
 }) => void
 
 declare type msrpReceiptChangedListener = (payload: {
-    conversationKey: string
+    conversation_id?: number
     eventId: string
     status: MSRPMessageStatus_2
     updatedAt: number
 }) => void
 
+/** Optional modifiers for an outgoing text/note message. */
+export declare interface MSRPSendMessageOptions {
+    /** event_id of the message being replied to — becomes `content.in_reply_to`. */
+    replyToEventId?: string;
+    /** Overrides `content.message_type` (defaults to 'text'). */
+    messageType?: string;
+    /** Attribution label for a forwarded message — becomes `content.forwarded_from`. */
+    forwardedFrom?: string;
+}
+
 declare class MSRPSession extends EventEmitter {
     _ua: UAExtendedInterface
     id: any
@@ -569,12 +649,17 @@ declare type msrpSyncCompletedListener = (payload: {
 }) => void
 
 declare type msrpTypingListener = (payload: {
-    conversationKey: string
+    conversation_id?: number
     sender: string
     isTyping: boolean
 }) => void
 
-declare interface MSRPTypingState {
+/**
+ * Transient typing indicator kept per-conversation. Not emitted by
+ * opensips-js; the wrapper composes it from `msrpTyping` events plus a
+ * `Date.now()` timestamp for UI decay.
+ */
+export declare interface MSRPTypingState {
     sender: string;
     isTyping: boolean;
     updatedAt: number;
@@ -671,6 +756,9 @@ export declare interface OpenSIPSEventMap extends UAEventMap {
     msrpReceiptChanged: msrpReceiptChangedListener
     msrpReactionChanged: msrpReactionChangedListener
     msrpTyping: msrpTypingListener
+    msrpMessageEdited: msrpMessageEditedListener
+    msrpMessageDeleted: msrpMessageDeletedListener
+    msrpPresence: msrpPresenceListener
     // JANUS
     conferenceStart: conferenceStartListener
     conferenceEnd: conferenceEndListener
@@ -831,9 +919,12 @@ declare interface UAExtendedInterface_2 extends UA {
     stop (): void
 }
 
-declare type UnreadCounts = {
-    [conversationKey: string]: number;
-};
+/**
+ * Per-conversation unread count derived from
+ * `MSRPConversationState.currentUserLastReadMessageId` + local timeline.
+ * Only conversations with count > 0 appear in the map.
+ */
+export declare type UnreadCounts = Record<string, number>;
 
 declare type updateRoomListener = (value: RoomChangeEmitType) => void
 
@@ -901,22 +992,68 @@ declare interface VsipAPIActions {
     sendMSRP: (msrpSessionId: string, body: string) => void
     safeSendMSRP: (body: string) => boolean
     sendCreateConversationMessage: (targetSip: string | string[]) => boolean
-    sendTextMessage: (conversationKey: string, text: string) => boolean
-    sendMediaMessage: (conversationKey: string, uploadResult: MSRPUploadResult, caption?: string) => boolean
-    sendReaction: (conversationKey: string, targetEventId: string, emoji: string) => boolean
-    sendTypingIndicator: (conversationKey: string, isTyping: boolean) => boolean
-    startTypingKeepAlive: (conversationKey: string) => void
-    stopTypingKeepAlive: (sendStop?: boolean) => void
-    sendReadReceipt: (conversationKey: string) => boolean
-    closeConversation: (conversationKey: string, reason?: string, cause?: string) => boolean
-    changeMemberRole: (conversationKey: string, targetUri: string, newRole: MSRPMemberRole) => boolean
-    acceptInvite: (conversationKey: string) => boolean
-    rejectInvite: (conversationKey: string) => boolean
-    leaveConversation: (conversationKey: string) => boolean
-    setActiveConversation: (conversationKey: string | null) => void
-    requestUploadUrl: (conversationKey: string, filename: string, mimeType: string, fileSize: number) => Promise<MSRPUploadResult>
-    requestFileAccess: (conversationKey: string, eventId: string) => Promise<unknown>
-    uploadFile: (conversationKey: string, file: File, caption?: string) => Promise<MSRPUploadResult>
+    sendTextMessage: (
+    conversationRef: MSRPConversationRef,
+    text: string,
+    options?: MSRPSendMessageOptions
+    ) => boolean
+    sendInternalNote: (
+    conversationRef: MSRPConversationRef,
+    text: string,
+    options?: Omit<MSRPSendMessageOptions, 'messageType'>
+    ) => boolean
+    editMessage: (conversationRef: MSRPConversationRef, targetEventId: string, newText: string) => boolean
+    deleteMessage: (conversationRef: MSRPConversationRef, targetEventId: string) => boolean
+    forwardMessage: (
+    sourceMessage: any,
+    targetConversationRef: MSRPConversationRef,
+    forwardedFromLabel?: string
+    ) => boolean
+    sendMediaMessage: (
+    conversationRef: MSRPConversationRef,
+    uploadResult: MSRPUploadResult,
+    caption?: string
+    ) => boolean
+    sendReaction: (
+    conversationRef: MSRPConversationRef,
+    targetEventId: string,
+    emoji: string,
+    action?: MSRPReactionAction
+    ) => boolean
+    removeReaction: (conversationRef: MSRPConversationRef, targetEventId: string, emoji: string) => boolean
+    sendTypingIndicator: (conversationRef: MSRPConversationRef) => boolean
+    startTypingKeepAlive: (conversationRef: MSRPConversationRef) => void
+    stopTypingKeepAlive: () => void
+    /**
+     * Mark the whole conversation as unread (server-side pointer → null).
+     * Optimistically applies the pointer locally so the UI reflects the
+     * change without waiting for a backend echo.
+     */
+    markConversationAsUnread: (conversationRef: MSRPConversationRef) => boolean
+    /**
+     * Mark `targetEventId` and every later message as unread. The pointer
+     * is moved to the message immediately preceding `targetEventId` in the
+     * local timeline; if the target is the very first message the pointer
+     * becomes null (whole conversation unread).
+     */
+    markAsUnreadFromMessage: (
+    conversationRef: MSRPConversationRef,
+    targetEventId: string
+    ) => boolean
+    closeConversation: (conversationRef: MSRPConversationRef, reason?: string, cause?: string) => boolean
+    changeMemberRole: (conversationRef: MSRPConversationRef, targetUri: string, newRole: MSRPMemberRole) => boolean
+    acceptInvite: (conversationRef: MSRPConversationRef) => boolean
+    rejectInvite: (conversationRef: MSRPConversationRef) => boolean
+    leaveConversation: (conversationRef: MSRPConversationRef) => boolean
+    setActiveConversation: (conversationId: string | null) => void
+    requestUploadUrl: (
+    conversationRef: MSRPConversationRef,
+    filename: string,
+    mimeType: string,
+    fileSize: number
+    ) => Promise<MSRPUploadResult>
+    requestFileAccess: (conversationRef: MSRPConversationRef, eventId: string) => Promise<unknown>
+    uploadFile: (conversationRef: MSRPConversationRef, file: File, caption?: string) => Promise<MSRPUploadResult>
 }
 
 declare interface VsipAPIState {
@@ -952,16 +1089,28 @@ declare interface VsipAPIState {
     isMSRPInitializing: Ref<boolean>
     hasActiveMsrpSession: ComputedRef<boolean>
     // ---------- MSRP conversation state ----------
-    // Metadata and chat history are kept as two parallel maps so that
-    // message activity doesn't invalidate metadata-only consumers.
-    conversations: Ref<{ [conversationKey: string]: MSRPConversationState }>
-    messagesByConversation: Ref<{ [conversationKey: string]: any[] }>
-    currentConversationKey: Ref<string | null>
+    // Conversations are keyed by their public numeric `conversation_id`
+    // stringified. Metadata and chat history are kept as two parallel maps
+    // so that message activity doesn't invalidate metadata-only consumers.
+    conversations: Ref<{ [conversationId: string]: MSRPConversationState }>
+    messagesByConversation: Ref<{ [conversationId: string]: any[] }>
+    currentConversationId: Ref<string | null>
     currentConversation: ComputedRef<MSRPConversationState | null>
     currentMessages: ComputedRef<any[]>
     sortedConversations: ComputedRef<MSRPConversationState[]>
-    typingByConversation: Ref<{ [conversationKey: string]: MSRPTypingState }>
-    unreadByConversation: Ref<UnreadCounts>
+    typingByConversation: Ref<{ [conversationId: string]: MSRPTypingState }>
+    presenceBySender: Ref<{ [sender: string]: MSRPPresenceState }>
+    /**
+     * Per-conversation unread count derived from
+     * `MSRPConversationState.currentUserLastReadMessageId` + local timeline.
+     * Only conversations with count > 0 appear in the map.
+     */
+    unreadByConversation: ComputedRef<UnreadCounts>
+    /**
+     * event_id of the first unread message per conversation. Consumers use
+     * this to place a "— New messages —" divider inside the open chat.
+     */
+    firstUnreadByConversation: ComputedRef<Record<string, string>>
 }
 
 export declare interface WebrtcMetricsConfigType {