opensips-js 0.1.48 → 0.1.50

package/dist/index.d.ts

@@ -604,6 +604,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";
@@ -611,27 +613,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
@@ -639,12 +662,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
@@ -652,11 +687,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'
 
@@ -682,10 +717,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
@@ -708,7 +758,7 @@ declare class MSRPModule {
     private uploadRequestTimeoutMs;
     private fileAccessTimeoutMs;
     private typingKeepAliveInterval;
-    private typingKeepAliveConversationKey;
+    private typingKeepAliveConversationId;
     private typingKeepAliveIntervalMs;
     constructor(context: any);
     get isMSRPInitializing(): boolean;
@@ -739,55 +789,101 @@ declare class MSRPModule {
     safeSendMSRP(body: string): boolean;
     private buildCreateConversationEvent;
     private buildTextMessageEvent;
+    private buildEditMessageEvent;
+    private buildDeleteMessageEvent;
     private buildMediaMessageEvent;
     private buildMemberEvent;
     private buildCloseConversationEvent;
     private buildReactionEvent;
     private buildTypingEvent;
     private buildReadReceiptEvent;
+    private buildUnreadEvent;
     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, lastEventId: string): boolean;
+    sendTextMessage(conversationRef: MSRPConversationRef, text: string, options?: MSRPSendMessageOptions): boolean;
+    /**
+     * Send an internal note — a message only visible to operators. The backend
+     * fan-out layer skips WhatsApp/SMS members when
+     * `content.message_type === 'internal_note'`, so it is never delivered to
+     * the customer channel.
+     */
+    sendInternalNote(conversationRef: MSRPConversationRef, text: string, options?: Omit<MSRPSendMessageOptions, 'messageType'>): boolean;
+    /**
+     * Edit a previously sent message. Only the original author may edit, and
+     * only within the per-channel edit window enforced by the backend.
+     */
+    editMessage(conversationRef: MSRPConversationRef, targetEventId: string, newText: string): boolean;
+    /**
+     * Soft-delete a message ("delete for everyone"). Only the original author
+     * may delete; the backend marks it `is_deleted` and fans out the deletion.
+     */
+    deleteMessage(conversationRef: MSRPConversationRef, targetEventId: string): boolean;
+    /**
+     * Forward the text of an existing message into another conversation.
+     * The caller owns `forwardedFromLabel`; when omitted the raw sender URI
+     * of the source message is used. The SDK never invents a display name.
+     */
+    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;
+    /** Convenience wrapper to remove a previously added reaction. */
+    removeReaction(conversationRef: MSRPConversationRef, targetEventId: string, emoji: string): boolean;
+    /**
+     * Emit a single `m.typing` heartbeat. Prefer {@link startTypingKeepAlive}
+     * — the heartbeat protocol requires a stream of `true` events.
+     */
+    sendTypingIndicator(conversationRef: MSRPConversationRef): boolean;
+    startTypingKeepAlive(conversationRef: MSRPConversationRef): void;
+    /**
+     * Stop our own heartbeat stream. Does NOT send a `typing=false` event —
+     * peers clear our indicator via their own silence-timeout, which also
+     * covers crash / network-drop / session-end cases.
+     */
+    stopTypingKeepAlive(): void;
+    sendReadReceipt(conversationRef: MSRPConversationRef, lastEventId: string): boolean;
+    /**
+     * Set the caller's per-user read pointer.
+     * - `lastReadEventId` = the last event to remain read (everything after
+     *   becomes unread).
+     * - `null` (or omitted) = mark the whole conversation as unread.
+     */
+    markAsUnread(conversationRef: MSRPConversationRef, lastReadEventId?: string | null): boolean;
     /**
      * Close a conversation. Only callers with role 'in_charge' or 'manager'
      * are allowed by the backend.
      */
-    closeConversation(conversationKey: string, reason?: string, cause?: string): boolean;
+    closeConversation(conversationRef: MSRPConversationRef, reason?: string, cause?: string): boolean;
     /**
-     * Change another member's role inside a conversation. The current user
-     * must be 'in_charge' or 'manager'.
+     * Change another member's role. Only callers with role 'in_charge' or
+     * 'manager' are allowed by the backend.
      */
-    changeMemberRole(conversationKey: string, targetUri: string, newRole: MSRPMemberRole): boolean;
-    acceptInvite(conversationKey: string): boolean;
-    rejectInvite(conversationKey: string): boolean;
-    leaveConversation(conversationKey: string): boolean;
+    changeMemberRole(conversationRef: MSRPConversationRef, targetUri: string, newRole: MSRPMemberRole): boolean;
+    acceptInvite(conversationRef: MSRPConversationRef): boolean;
+    rejectInvite(conversationRef: MSRPConversationRef): boolean;
+    leaveConversation(conversationRef: MSRPConversationRef): boolean;
     /**
-     * Ask the server for a presigned upload URL via MSRP. Resolves with the
-     * upload metadata once the matching `m.upload.response` arrives, or
-     * rejects after `uploadRequestTimeoutMs` if no response is received.
+     * Ask the server for a presigned upload URL. Resolves with the upload
+     * metadata once the matching `m.upload.response` arrives, or rejects
+     * after `uploadRequestTimeoutMs`.
      */
-    requestUploadUrl(conversationKey: string, filename: string, mimeType: string, fileSize: number): Promise<MSRPUploadResult>;
+    requestUploadUrl(conversationRef: MSRPConversationRef, filename: string, mimeType: string, fileSize: number): Promise<MSRPUploadResult>;
     /**
-     * Ask the server for a one-shot download URL for a previously-uploaded
-     * file. Resolves with the download URL, rejects on timeout or explicit
-     * server error.
+     * Ask the server for a one-shot download URL. Resolves with the URL,
+     * rejects on timeout or explicit server error.
      */
-    requestFileAccess(conversationKey: string, eventId: string): Promise<string>;
+    requestFileAccess(conversationRef: MSRPConversationRef, eventId: string): Promise<string>;
     /**
      * High-level helper: request a presigned URL, POST the file to it, then
      * send the resulting media message into the conversation in one go.
      */
-    uploadFile(conversationKey: string, file: File, caption?: string): Promise<MSRPUploadResult>;
+    uploadFile(conversationRef: MSRPConversationRef, file: File, caption?: string): Promise<MSRPUploadResult>;
     private processIncomingMSRPMessage;
     private handleIncomingEvent;
     private handleIncomingSync;
     private handleIncomingConversationCreate;
     private handleIncomingConversationMessage;
+    private handleIncomingMessageDelete;
+    private handleIncomingConversationReopen;
+    private handleIncomingPresence;
     private handleIncomingConversationClosed;
     private handleIncomingReceipt;
     private handleIncomingTyping;
@@ -796,11 +892,14 @@ declare class MSRPModule {
     private handleIncomingUploadResponse;
     private handleIncomingFileAccessResponse;
     private upsertConversationState;
+    private toConversationId;
+    private sendEvent;
     private snapshotConversation;
     private snapshotConversationsMap;
     isConversationClosed(conversation: MSRPConversationState | undefined | null): boolean;
-    private conversationKeyOf;
+    private conversationIdOf;
     extractSipUser(sipUri: string | null | undefined): string | null;
+    private readLastReadEventIdFromMemberContent;
     extractDisplayName(uri: string | null | undefined): string;
 }
 
@@ -820,8 +919,18 @@ 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
+
+export declare type MSRPReactionAction = 'add' | 'remove';
+
 declare type msrpReactionChangedListener = (payload: {
-    conversationKey: string
+    conversation_id?: number
     eventId: string
     emoji: string
     action: 'add' | 'remove'
@@ -830,12 +939,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
@@ -1034,7 +1153,7 @@ declare type msrpSyncCompletedListener = (payload: {
 }) => void
 
 declare type msrpTypingListener = (payload: {
-    conversationKey: string
+    conversation_id?: number
     sender: string
     isTyping: boolean
 }) => void
@@ -1120,6 +1239,9 @@ export declare interface OpenSIPSEventMap extends UAEventMap {
     msrpReceiptChanged: msrpReceiptChangedListener
     msrpReactionChanged: msrpReactionChangedListener
     msrpTyping: msrpTypingListener
+    msrpMessageEdited: msrpMessageEditedListener
+    msrpMessageDeleted: msrpMessageDeletedListener
+    msrpPresence: msrpPresenceListener
     // JANUS
     conferenceStart: conferenceStartListener
     conferenceEnd: conferenceEndListener