opensips-js 0.1.46 → 0.1.48

package/dist/index.d.ts

@@ -370,7 +370,7 @@ declare type changeActiveCallsListener = (event: { [key: string]: ICall }) => vo
 
 declare type changeActiveInputMediaDeviceListener = (event: string) => void
 
-declare type changeActiveMessagesListener = (event: { [key: string]: IMessage }) => void
+declare type changeActiveMessagesListener = (event: { [key: string]: IMessage_2 }) => void
 
 declare type changeActiveOutputMediaDeviceListener = (event: string) => void
 
@@ -394,13 +394,15 @@ declare type changeIsDNDListener = (value: boolean) => void
 
 declare type changeIsMutedListener = (value: boolean) => void
 
+declare type changeMsrpSessionListener = (session: IMessage_2 | null) => void
+
 declare type changeMuteWhenJoinListener = (value: boolean) => void
 
 declare type changeNoiseReductionStateListener = (event: boolean) => void
 
 declare type changeVideoStateListener = (state: boolean) => void
 
-declare type ChangeVolumeEventType = {
+export declare type ChangeVolumeEventType = {
     callId: string
     volume: number
 }
@@ -415,7 +417,7 @@ declare type connectionListener = (value: boolean) => void
 
 declare type connectionStateChangeListener = (event: ConnectionStateChangeType) => void
 
-declare type ConnectionStateChangeType = {
+export declare type ConnectionStateChangeType = {
     session: RTCSessionExtended,
     connectionState: string
 }
@@ -428,7 +430,7 @@ declare interface ConnectOptions {
     pcConfig?: object;
 }
 
-declare interface CustomLoggerType {
+export declare interface CustomLoggerType {
     log: CommonLogMethodType
     warn: CommonLogMethodType
     error: CommonLogMethodType
@@ -449,7 +451,7 @@ declare type ExactConstraints_2 = {
     video?: boolean;
 }
 
-declare interface ICall extends RTCSessionExtended {
+export declare interface ICall extends RTCSessionExtended {
     roomId?: number
     localMuted?: boolean
     localHold?: boolean
@@ -458,14 +460,14 @@ declare interface ICall extends RTCSessionExtended {
     putOnHoldTimestamp?: number
 }
 
-declare interface ICallStatus {
+export declare interface ICallStatus {
     isMoving: boolean
     isTransferring: boolean
     isMerging: boolean
     isTransferred: boolean
 }
 
-declare interface IMessage extends MSRPSessionExtended {
+export declare interface IMessage extends MSRPSessionExtended {
     roomId?: number
     localMuted?: boolean
     localHold?: boolean
@@ -473,6 +475,14 @@ declare interface IMessage extends MSRPSessionExtended {
     terminate(): void
 }
 
+declare interface IMessage_2 extends MSRPSessionExtended_2 {
+    roomId?: number
+    localMuted?: boolean
+    localHold?: boolean
+    audioTag?: StreamMediaType_2
+    terminate(): void
+}
+
 declare interface IncomingMSRPSessionEvent {
     originator: Originator.REMOTE;
     session: MSRPSession;
@@ -481,9 +491,9 @@ declare interface IncomingMSRPSessionEvent {
 
 declare type IncomingMSRPSessionListener = (event: IncomingMSRPSessionEvent) => void;
 
-declare type IOpenSIPSConfiguration = Omit<UAConfigurationExtended, 'sockets'>
+export declare type IOpenSIPSConfiguration = Omit<UAConfigurationExtended, 'sockets'>
 
-declare interface IOpenSIPSJSOptions {
+export declare interface IOpenSIPSJSOptions {
     configuration: IOpenSIPSConfiguration
     socketInterfaces: [ string ]
     sipDomain: string
@@ -498,7 +508,7 @@ declare interface IOpenSIPSJSOptions {
     msrpWs?: boolean
 }
 
-declare interface IRoom {
+export declare interface IRoom {
     started: Date
     incomingInProgress: boolean
     roomId: number
@@ -508,7 +518,7 @@ declare type IRoomUpdate = Omit<IRoom, 'started'> & {
     started?: Date
 }
 
-declare interface ITimeData {
+export declare interface ITimeData {
     callId: string
     hours: number
     minutes: number
@@ -560,9 +570,11 @@ declare type Listener_2 = (event: unknown) => void
 
 declare type Listener_3 = (event: unknown) => void
 
-declare type ListenerCallbackFnType<T extends ListenersKeyType> = OpenSIPSEventMap[T]
+export declare type ListenerCallbackFnType<T extends ListenersKeyType> = OpenSIPSEventMap[T]
 
-declare type ListenerEventType = EndEvent | IncomingEvent | OutgoingEvent | IncomingAckEvent | OutgoingAckEvent
+export declare type ListenerEventType = EndEvent | IncomingEvent | OutgoingEvent | IncomingAckEvent | OutgoingAckEvent
+
+declare type ListenerEventType_2 = EndEvent | IncomingEvent | OutgoingEvent | IncomingAckEvent | OutgoingAckEvent
 
 declare type ListenersKeyType = keyof OpenSIPSEventMap
 
@@ -587,8 +599,73 @@ declare const MODULES: {
 
 declare type Modules = AudioModuleName | VideoModuleName | MSRPModuleName
 
+export declare const MSRP_EVT: {
+    readonly CREATE: "m.conversation.create";
+    readonly MESSAGE: "m.conversation.message";
+    readonly MEMBER: "m.conversation.member";
+    readonly CLOSED: "m.conversation.closed";
+    readonly SYNC: "m.sync";
+    readonly UPLOAD_REQUEST: "m.upload.request";
+    readonly UPLOAD_RESPONSE: "m.upload.response";
+    readonly FILE_ACCESS_REQUEST: "m.file.access.request";
+    readonly FILE_ACCESS_RESPONSE: "m.file.access.response";
+    readonly REACTION: "m.reaction";
+    readonly TYPING: "m.typing";
+    readonly SENT: "m.sent";
+    readonly DELIVERED: "m.delivered";
+    readonly READ: "m.read";
+    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
+
+export 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 interface MSRPConversationState_2 {
+    conversationKey: string
+    creator: string | null
+    members: Set<string>
+    memberRoles: Map<string, MSRPMemberRole_2>
+    currentUserRole: MSRPMemberRole_2
+    currentUserStatus: MSRPMembership_2 | 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_2>
+}) => void
+
 declare type MSRPInitializingListener = (sessionId: string | undefined) => void
 
+export declare type MSRPMemberRole = 'in_charge' | 'manager' | 'assigned'
+
+declare type MSRPMemberRole_2 = 'in_charge' | 'manager' | 'assigned'
+
+export declare type MSRPMembership = 'join' | 'leave' | 'invite' | 'ban'
+
+declare type MSRPMembership_2 = 'join' | 'leave' | 'invite' | 'ban'
+
 declare class MSRPMessage {
     protocol: string
     ident: string
@@ -604,37 +681,127 @@ declare class MSRPMessage {
     toString(): string
 }
 
-declare type MSRPMessageEventType = {
+declare type msrpMessageAddedListener = (payload: {
+    conversationKey: string
+    message: any
+}) => void
+
+export declare type MSRPMessageEventType = {
     message: MSRPMessage,
-    session: MSRPSessionExtended
+    session: MSRPSessionExtended_2
 }
 
 declare type MSRPMessageListener = (event: MSRPMessageEventType) => void;
 
+export declare type MSRPMessageStatus = 'pending' | 'sent' | 'delivered' | 'read' | 'failed'
+
+declare type MSRPMessageStatus_2 = '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;
+    initMSRP(options?: any): void;
+    initMSRPAndSendMessage(target: string, body: string, options?: any): void;
+    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.
+     */
+    safeSendMSRP(body: string): boolean;
+    private buildCreateConversationEvent;
+    private buildTextMessageEvent;
+    private buildMediaMessageEvent;
+    private buildMemberEvent;
+    private buildCloseConversationEvent;
+    private buildReactionEvent;
+    private buildTypingEvent;
+    private buildReadReceiptEvent;
+    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;
+    /**
+     * 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>;
+    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;
+    private snapshotConversation;
+    private snapshotConversationsMap;
+    isConversationClosed(conversation: MSRPConversationState | undefined | null): boolean;
+    private conversationKeyOf;
+    extractSipUser(sipUri: string | null | undefined): string | null;
+    extractDisplayName(uri: string | null | undefined): string;
 }
 
 declare type MSRPModuleName = typeof MODULES.MSRP
@@ -653,6 +820,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_2
+    updatedAt: number
+}) => void
+
 declare class MSRPSession extends EventEmitter {
     _ua: UAExtendedInterface
     id: any
@@ -797,7 +980,30 @@ declare interface MSRPSessionEventMap_2 {
     'peerconnection:setremotedescriptionfailed': Listener_3;
 }
 
-declare interface MSRPSessionExtended extends MSRPSession_2 {
+export declare interface MSRPSessionExtended extends MSRPSession_2 {
+    id: string
+    status: string
+    start_time: Date
+    direction: SessionDirection
+    _id: string
+    _cancel_reason: string
+    _contact: string
+    _end_time: Date
+    _eventsCount: number
+    _from_tag: string
+    _is_canceled: boolean
+    _is_confirmed: boolean
+    _late_sdp: string
+    _status: number
+    _remote_identity: string
+    target_addr: Array<string>
+    answer(options?: any): void
+    _init_incomeing(): void
+    sendMSRP(body: string): void
+    on<T extends keyof MSRPSessionEventMap_2>(type: T, listener: MSRPSessionEventMap_2[T]): this;
+}
+
+declare interface MSRPSessionExtended_2 extends MSRPSession_2 {
     id: string
     status: string
     start_time: Date
@@ -822,9 +1028,32 @@ declare interface MSRPSessionExtended extends MSRPSession_2 {
 
 declare type MSRPSessionListener = IncomingMSRPSessionListener | OutgoingMSRPSessionListener;
 
-declare type NoiseReductionMode = 'disabled' | 'enabled' | 'dynamic'
+declare type msrpSyncCompletedListener = (payload: {
+    conversations: { [key: string]: MSRPConversationState_2 }
+    messagesByConversation: { [key: string]: any[] }
+}) => void
+
+declare type msrpTypingListener = (payload: {
+    conversationKey: string
+    sender: string
+    isTyping: boolean
+}) => void
+
+export 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
+}
+
+export declare type NoiseReductionMode = 'disabled' | 'enabled' | 'dynamic'
 
-declare interface NoiseReductionOptions {
+export declare interface NoiseReductionOptions {
     mode: NoiseReductionMode,
     vadModule?: VADModule
     vadConfig?: Partial<VADOptions>
@@ -845,11 +1074,11 @@ declare interface NoiseReductionOptions {
     onnxWASMBasePath?: string
 }
 
-declare type NoiseReductionOptionsWithoutVadModule = Omit<NoiseReductionOptions, 'vadModule'>
+export declare type NoiseReductionOptionsWithoutVadModule = Omit<NoiseReductionOptions, 'vadModule'>
 
 declare type OnTransportCallback = (parsed: object, message: string) => void
 
-declare interface OpenSIPSEventMap extends UAEventMap {
+export declare interface OpenSIPSEventMap extends UAEventMap {
     ready: readyListener
     connection: connectionListener
     reconnecting: reconnectionListener
@@ -881,6 +1110,16 @@ declare interface OpenSIPSEventMap extends UAEventMap {
     connectionStateChange: connectionStateChangeListener
     newMSRPMessage: MSRPMessageListener
     newMSRPSession: MSRPSessionListener
+    // MSRP events listeners
+    changeMsrpSession: changeMsrpSessionListener
+    msrpSyncCompleted: msrpSyncCompletedListener
+    msrpConversationCreated: msrpConversationCreatedListener
+    msrpConversationRemoved: msrpConversationRemovedListener
+    msrpConversationUpdated: msrpConversationUpdatedListener
+    msrpMessageAdded: msrpMessageAddedListener
+    msrpReceiptChanged: msrpReceiptChangedListener
+    msrpReactionChanged: msrpReactionChangedListener
+    msrpTyping: msrpTypingListener
     // JANUS
     conferenceStart: conferenceStartListener
     conferenceEnd: conferenceEndListener
@@ -1026,11 +1265,22 @@ declare interface StreamMediaType extends HTMLAudioElement {
     setSinkId (id: string): Promise<void>
 }
 
+declare interface StreamMediaType_2 extends HTMLAudioElement {
+    className: string
+    setSinkId (id: string): Promise<void>
+}
+
 declare type TestEventListener = (event: { test: string }) => void
 
 declare interface TriggerListenerOptions {
     listenerType: string
     session: RTCSessionExtended
+    event?:  ListenerEventType_2
+}
+
+export declare interface TriggerMSRPListenerOptions {
+    listenerType: string
+    session: MSRPSessionExtended
     event?:  ListenerEventType
 }
 
@@ -1164,7 +1414,7 @@ declare class VideoModule {
 
 declare type VideoModuleName = typeof MODULES.VIDEO
 
-declare interface WebrtcMetricsConfigType {
+export declare interface WebrtcMetricsConfigType {
     refreshEvery?: number
     startAfter?: number
     stopAfter?: number