opensips-js 0.1.46 → 0.1.47

package/dist/index.d.ts

@@ -394,6 +394,8 @@ declare type changeIsDNDListener = (value: boolean) => void
 
 declare type changeIsMutedListener = (value: boolean) => void
 
+declare type changeMsrpSessionListener = (session: IMessage | null) => void
+
 declare type changeMuteWhenJoinListener = (value: boolean) => void
 
 declare type changeNoiseReductionStateListener = (event: boolean) => void
@@ -587,8 +589,52 @@ declare const MODULES: {
 
 declare type Modules = AudioModuleName | VideoModuleName | MSRPModuleName
 
+declare type msrpConversationCreatedListener = (payload: {
+    conversationKey: string
+    conversation: MSRPConversationState
+}) => void
+
+declare type msrpConversationRemovedListener = (payload: { conversationKey: string }) => void
+
+/**
+ * Protocol-level conversation state owned by MSRPModule.
+ *
+ * Intentionally does NOT carry a `messages` array - the module is a pure
+ * pipe for chat history. Live messages are emitted via `msrpMessageAdded`
+ * and historical messages from `m.sync` come through the
+ * `messagesByConversation` field of the `msrpSyncCompleted` payload.
+ * The consumer (e.g. a Vue composable) is responsible for collecting them
+ * into whatever data structure it needs and for downstream concerns like
+ * deduplication, reaction aggregation and receipt application.
+ */
+declare interface MSRPConversationState {
+    conversationKey: string;
+    creator: string | null;
+    members: Set<string>;
+    memberRoles: Map<string, MSRPMemberRole>;
+    currentUserRole: MSRPMemberRole;
+    currentUserStatus: MSRPMembership | null;
+    state_events: {
+        [key: string]: {
+            [stateKey: string]: any;
+        };
+    };
+    created_at: number;
+    updated_at: number;
+    status?: string;
+}
+
+declare type msrpConversationUpdatedListener = (payload: {
+    conversationKey: string
+    patch: Partial<MSRPConversationState>
+}) => void
+
 declare type MSRPInitializingListener = (sessionId: string | undefined) => void
 
+declare type MSRPMemberRole = 'in_charge' | 'manager' | 'assigned';
+
+declare type MSRPMembership = 'join' | 'leave' | 'invite' | 'ban';
+
 declare class MSRPMessage {
     protocol: string
     ident: string
@@ -604,6 +650,11 @@ declare class MSRPMessage {
     toString(): string
 }
 
+declare type msrpMessageAddedListener = (payload: {
+    conversationKey: string
+    message: any
+}) => void
+
 declare type MSRPMessageEventType = {
     message: MSRPMessage,
     session: MSRPSessionExtended
@@ -611,30 +662,177 @@ declare type MSRPMessageEventType = {
 
 declare type MSRPMessageListener = (event: MSRPMessageEventType) => void;
 
+declare type MSRPMessageStatus = 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
+
 declare class MSRPModule {
     private context;
-    private activeMessages;
-    private extendedMessages;
-    private msrpHistory;
+    private msrpSession;
+    private extendedSession;
     private isMSRPInitializingValue;
+    private conversationsMap;
+    private pendingUploads;
+    private pendingFileAccessRequests;
+    private uploadRequestTimeoutMs;
+    private fileAccessTimeoutMs;
+    private typingKeepAliveInterval;
+    private typingKeepAliveConversationKey;
+    private typingKeepAliveIntervalMs;
     constructor(context: any);
     get isMSRPInitializing(): boolean;
-    get getActiveMessages(): {
-        [key: string]: IMessage;
+    get getMsrpSession(): IMessage;
+    get hasActiveSession(): boolean;
+    get conversations(): {
+        [key: string]: MSRPConversationState;
     };
-    msrpAnswer(callId: string): void;
+    msrpAnswer(_callId: string): void;
     updateMSRPSession(value: IMessage): void;
-    private addMMSRPSession;
+    private setMSRPSession;
     private addMSRPMessage;
-    messageTerminate(callId: string): void;
+    messageTerminate(_callId: string): void;
     private addMessageSession;
     private triggerMSRPListener;
-    private removeMMSRPSession;
-    private activeMessageListRemove;
+    private clearMSRPSession;
     private newMSRPSessionCallback;
     private setIsMSRPInitializing;
-    initMSRP(target: string, body: string, options: any): void;
-    sendMSRP(msrpSessionId: string, body: string): void;
+    private getUserUri;
+    /**
+     * Open an MSRP session for the currently logged-in user. The SIP
+     * identity is resolved automatically from the OpenSIPSJS
+     * configuration, so the caller never has to pass it. Use this when
+     * the session is intended to act as a long-lived transport pipe and
+     * the first payload will be sent later through one of the higher-level
+     * actions (e.g. `sendCreateConversationMessage`).
+     */
+    initMSRP(options?: any): void;
+    /**
+     * Open an MSRP session and push `body` as the first MSRP frame the
+     * moment the session goes active. Use this for the legacy
+     * "compose-and-send" flow where the first message is known at the
+     * time the session is opened.
+     */
+    initMSRPAndSendMessage(target: string, body: string, options?: any): void;
+    /**
+     * Public raw send - kept for backward-compat with the old multi-session API.
+     * Ignores the passed callId/sessionId because we only ever hold one session.
+     */
+    sendMSRP(_msrpSessionId: string, body: string): void;
+    /**
+     * Safe wrapper around session.sendMSRP. Returns true when the message was
+     * handed off to the session; false when there is no active session or the
+     * underlying send threw. On failure the stored session is cleared so the
+     * next send attempt does not silently drop traffic on a half-dead session.
+     */
+    safeSendMSRP(body: string): boolean;
+    private buildCreateConversationEvent;
+    private buildTextMessageEvent;
+    private buildMediaMessageEvent;
+    private buildMemberEvent;
+    private buildCloseConversationEvent;
+    private buildReactionEvent;
+    private buildTypingEvent;
+    private buildReadReceiptEvent;
+    /**
+     * Create a new conversation by inviting one or more SIP URIs.
+     * Accepts plain numbers/usernames and rewrites them into full SIP URIs
+     * against the domain OpenSIPSJS was initialized with.
+     */
+    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;
+    /**
+     * Start an automatic typing keep-alive loop for `conversationKey`. While
+     * active, a typing=true event is re-sent every `typingKeepAliveIntervalMs`
+     * so the remote side does not time out the indicator. Calling this with a
+     * different conversationKey or calling `stopTypingKeepAlive()` cancels
+     * any in-flight loop.
+     */
+    startTypingKeepAlive(conversationKey: string): void;
+    stopTypingKeepAlive(sendStop?: boolean): void;
+    /**
+     * Send a read receipt for `lastEventId` in `conversationKey`. The
+     * caller is responsible for resolving which event_id represents the
+     * "last seen" message because the module no longer stores chat history.
+     */
+    sendReadReceipt(conversationKey: string, lastEventId: string): 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;
+    /**
+     * Change another member's role inside a conversation. The current user
+     * must be 'in_charge' or 'manager'.
+     */
+    changeMemberRole(conversationKey: string, targetUri: string, newRole: MSRPMemberRole): boolean;
+    acceptInvite(conversationKey: string): boolean;
+    rejectInvite(conversationKey: string): boolean;
+    leaveConversation(conversationKey: string): 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.
+     */
+    requestUploadUrl(conversationKey: string, 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.
+     */
+    requestFileAccess(conversationKey: string, 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>;
+    /**
+     * Parse a raw MSRP `newMessage` payload and dispatch it to the right
+     * conversation-state mutator. Outgoing messages and non-JSON payloads
+     * are ignored so the rest of the pipeline stays pure.
+     */
+    private processIncomingMSRPMessage;
+    private handleIncomingEvent;
+    private handleIncomingSync;
+    private handleIncomingConversationCreate;
+    private handleIncomingConversationMessage;
+    private handleIncomingConversationClosed;
+    private handleIncomingReceipt;
+    private handleIncomingTyping;
+    private handleIncomingReaction;
+    private handleIncomingConversationMember;
+    private handleIncomingUploadResponse;
+    private handleIncomingFileAccessResponse;
+    private upsertConversationState;
+    /**
+     * Make a shallow snapshot of a conversation that is safe to hand off
+     * to an external consumer (e.g. a Vue composable).
+     *
+     * The mutable top-level collections (members, memberRoles,
+     * state_events) are cloned so subsequent internal mutations by the
+     * module cannot leak into the consumer's state. There is no
+     * `messages` field - chat history is owned by the consumer.
+     */
+    private snapshotConversation;
+    /**
+     * Snapshot the whole conversations map - used only for the bulk
+     * `msrpSyncCompleted` emit.
+     */
+    private snapshotConversationsMap;
+    isConversationClosed(conversation: MSRPConversationState | undefined | null): boolean;
+    /**
+     * Extract the conversationKey from either a string or an event/conversation object.
+     */
+    private conversationKeyOf;
+    /**
+     * Extract the user-part of a SIP URI, e.g. sip:103@example.com -> 103.
+     */
+    extractSipUser(sipUri: string | null | undefined): string | null;
+    /**
+     * Best-effort human-readable name for any URI we may encounter
+     * (SIP / WhatsApp / SMS / GreenAPI).
+     */
+    extractDisplayName(uri: string | null | undefined): string;
 }
 
 declare type MSRPModuleName = typeof MODULES.MSRP
@@ -653,6 +851,22 @@ declare interface MSRPOptions_2 extends AnswerOptions {
     fromDisplayName?: string;
 }
 
+declare type msrpReactionChangedListener = (payload: {
+    conversationKey: string
+    eventId: string
+    emoji: string
+    action: 'add' | 'remove'
+    sender: string
+    updatedAt: number
+}) => void
+
+declare type msrpReceiptChangedListener = (payload: {
+    conversationKey: string
+    eventId: string
+    status: MSRPMessageStatus
+    updatedAt: number
+}) => void
+
 declare class MSRPSession extends EventEmitter {
     _ua: UAExtendedInterface
     id: any
@@ -822,6 +1036,29 @@ declare interface MSRPSessionExtended extends MSRPSession_2 {
 
 declare type MSRPSessionListener = IncomingMSRPSessionListener | OutgoingMSRPSessionListener;
 
+declare type msrpSyncCompletedListener = (payload: {
+    conversations: { [key: string]: MSRPConversationState }
+    messagesByConversation: { [key: string]: any[] }
+}) => void
+
+declare type msrpTypingListener = (payload: {
+    conversationKey: string
+    sender: string
+    isTyping: boolean
+}) => void
+
+declare interface MSRPUploadResult {
+    upload_url: string;
+    expires_in?: number;
+    mime_type: string;
+    request_id: string;
+    filename?: string;
+    preview_url?: string;
+    icon_url?: string;
+    transcription?: string;
+    media_type?: string;
+}
+
 declare type NoiseReductionMode = 'disabled' | 'enabled' | 'dynamic'
 
 declare interface NoiseReductionOptions {
@@ -881,6 +1118,16 @@ declare interface OpenSIPSEventMap extends UAEventMap {
     connectionStateChange: connectionStateChangeListener
     newMSRPMessage: MSRPMessageListener
     newMSRPSession: MSRPSessionListener
+    // MSRP - granular conversation events
+    changeMsrpSession: changeMsrpSessionListener
+    msrpSyncCompleted: msrpSyncCompletedListener
+    msrpConversationCreated: msrpConversationCreatedListener
+    msrpConversationRemoved: msrpConversationRemovedListener
+    msrpConversationUpdated: msrpConversationUpdatedListener
+    msrpMessageAdded: msrpMessageAddedListener
+    msrpReceiptChanged: msrpReceiptChangedListener
+    msrpReactionChanged: msrpReactionChangedListener
+    msrpTyping: msrpTypingListener
     // JANUS
     conferenceStart: conferenceStartListener
     conferenceEnd: conferenceEndListener