opensips-js 0.1.52 → 0.1.53

package/dist/index.d.ts

@@ -600,6 +600,9 @@ declare const MODULES: {
 
 declare type Modules = AudioModuleName | VideoModuleName | MSRPModuleName
 
+/** Max caption length after trim, matching server-side `m.upload.request` contract. */
+export declare const MSRP_CAPTION_MAX_LENGTH = 1024;
+
 export declare const MSRP_EVT: {
     readonly CREATE: "m.conversation.create";
     readonly MESSAGE: "m.conversation.message";
@@ -607,6 +610,10 @@ export declare const MSRP_EVT: {
     readonly CLOSED: "m.conversation.closed";
     readonly REOPEN: "m.conversation.reopen";
     readonly DELETE: "m.conversation.delete";
+    readonly MESSAGE_HIDE: "m.message.hide";
+    readonly CONVERSATION_TAG: "m.conversation.tag";
+    readonly MESSAGE_TAG: "m.message.tag";
+    readonly ERROR: "m.error";
     readonly SYNC: "m.sync";
     readonly UPLOAD_REQUEST: "m.upload.request";
     readonly UPLOAD_RESPONSE: "m.upload.response";
@@ -660,6 +667,11 @@ export declare interface MSRPConversationState {
     created_at: number
     updated_at: number
     status?: string
+    /**
+     * Shared conversation tags from `m.sync` / `m.conversation.tag`.
+     * Compared by normalized (lowercase, trimmed) `name`.
+     */
+    tags?: MSRPTag[]
 }
 
 declare interface MSRPConversationState_2 {
@@ -685,13 +697,32 @@ declare interface MSRPConversationState_2 {
     created_at: number
     updated_at: number
     status?: string
+    /**
+     * Shared conversation tags from `m.sync` / `m.conversation.tag`.
+     * Compared by normalized (lowercase, trimmed) `name`.
+     */
+    tags?: MSRPTag_2[]
 }
 
+declare type msrpConversationTaggedListener = (payload: {
+    conversation_id?: number
+    action: 'add' | 'remove'
+    tag: MSRPTag_2
+    actorUri: string
+    updatedAt: number
+}) => void
+
 declare type msrpConversationUpdatedListener = (payload: {
     conversation_id?: number
     patch: Partial<MSRPConversationState_2>
 }) => void
 
+declare type msrpErrorListener = (payload: {
+    conversation_id?: number
+    error: string
+    event: unknown
+}) => void
+
 declare type MSRPInitializingListener = (value: boolean) => void
 
 export declare type MSRPMemberRole = 'in_charge' | 'manager' | 'assigned'
@@ -742,12 +773,27 @@ export declare type MSRPMessageEventType = {
     session: MSRPSessionExtended_2
 }
 
+declare type msrpMessageHiddenListener = (payload: {
+    conversation_id?: number
+    eventId: string
+    updatedAt: number
+}) => void
+
 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 type msrpMessageTaggedListener = (payload: {
+    conversation_id?: number
+    eventId: string
+    action: 'add' | 'remove'
+    tag: MSRPTag_2
+    actorUri: string
+    updatedAt: number
+}) => void
+
 declare class MSRPModule {
     private context;
     private msrpSession;
@@ -792,6 +838,9 @@ declare class MSRPModule {
     private buildTextMessageEvent;
     private buildEditMessageEvent;
     private buildDeleteMessageEvent;
+    private buildHideMessageEvent;
+    private buildConversationTagEvent;
+    private buildMessageTagEvent;
     private buildMediaMessageEvent;
     private buildMemberEvent;
     private buildCloseConversationEvent;
@@ -818,12 +867,37 @@ declare class MSRPModule {
      * may delete; the backend marks it `is_deleted` and fans out the deletion.
      */
     deleteMessage(conversationRef: MSRPConversationRef, targetEventId: string): boolean;
+    /**
+     * Hide a message from the current agent's timeline only. Any joined
+     * SIP/assistant member may hide any `m.conversation.message` (own,
+     * others', or internal_note). There is no undo in V1.
+     */
+    hideMessage(conversationRef: MSRPConversationRef, targetEventId: string): boolean;
+    /**
+     * Add a shared free-text tag to a conversation. Duplicate names on the
+     * same conversation are ignored by the server.
+     */
+    tagConversation(conversationRef: MSRPConversationRef, name: string, color?: string): boolean;
+    /** Remove a conversation tag by name (compared case-insensitively). */
+    untagConversation(conversationRef: MSRPConversationRef, name: string): boolean;
+    /**
+     * Add a shared free-text tag to a specific message. Duplicate names on
+     * the same message are ignored by the server.
+     */
+    tagMessage(conversationRef: MSRPConversationRef, targetEventId: string, name: string, color?: string): boolean;
+    /** Remove a message tag by name (compared case-insensitively). */
+    untagMessage(conversationRef: MSRPConversationRef, targetEventId: string, name: 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;
+    /**
+     * Emit a client-side media `m.conversation.message`. Prefer
+     * {@link uploadFile} — with server-side media commit the server
+     * creates the timeline event after the file POST.
+     */
     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. */
@@ -865,16 +939,20 @@ declare class MSRPModule {
      * Ask the server for a presigned upload URL. Resolves with the upload
      * metadata once the matching `m.upload.response` arrives, or rejects
      * after `uploadRequestTimeoutMs`.
+     *
+     * Optional `caption` is stored on the upload token (server-side media
+     * commit). Whitespace-only is treated as absent. Max 1024 chars after trim.
      */
-    requestUploadUrl(conversationRef: MSRPConversationRef, filename: string, mimeType: string, fileSize: number): Promise<MSRPUploadResult>;
+    requestUploadUrl(conversationRef: MSRPConversationRef, filename: string, mimeType: string, fileSize: number, caption?: string): Promise<MSRPUploadResult>;
     /**
      * Ask the server for a one-shot download URL. Resolves with the URL,
      * rejects on timeout or explicit server error.
      */
     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.
+     * High-level helper: request a presigned URL and POST the file to it.
+     * The server commits the media (and optional caption) as a single
+     * `m.conversation.message` — do not send a separate text event.
      */
     uploadFile(conversationRef: MSRPConversationRef, file: File, caption?: string): Promise<MSRPUploadResult>;
     private processIncomingMSRPMessage;
@@ -883,6 +961,10 @@ declare class MSRPModule {
     private handleIncomingConversationCreate;
     private handleIncomingConversationMessage;
     private handleIncomingMessageDelete;
+    private handleIncomingMessageHide;
+    private handleIncomingConversationTag;
+    private handleIncomingMessageTag;
+    private handleIncomingError;
     private handleIncomingConversationReopen;
     private handleIncomingPresence;
     private handleIncomingConversationClosed;
@@ -1155,6 +1237,22 @@ declare type msrpSyncCompletedListener = (payload: {
     messagesByConversation: { [key: string]: any[] }
 }) => void
 
+export declare interface MSRPTag {
+    name: string
+    color?: string
+    added_by?: string
+    added_at?: number
+}
+
+declare interface MSRPTag_2 {
+    name: string
+    color?: string
+    added_by?: string
+    added_at?: number
+}
+
+export declare type MSRPTagAction = 'add' | 'remove';
+
 declare type msrpTypingListener = (payload: {
     conversation_id?: number
     sender: string
@@ -1244,6 +1342,10 @@ export declare interface OpenSIPSEventMap extends UAEventMap {
     msrpTyping: msrpTypingListener
     msrpMessageEdited: msrpMessageEditedListener
     msrpMessageDeleted: msrpMessageDeletedListener
+    msrpMessageHidden: msrpMessageHiddenListener
+    msrpConversationTagged: msrpConversationTaggedListener
+    msrpMessageTagged: msrpMessageTaggedListener
+    msrpError: msrpErrorListener
     msrpPresence: msrpPresenceListener
     // JANUS
     conferenceStart: conferenceStartListener
@@ -1285,9 +1387,9 @@ declare class OpenSIPSJS extends UAExtended {
     isWaitingForSessionHangup(): boolean;
     stopSessionAfterWaiting(): void;
     private get hasActiveSessions();
-    on<T extends ListenersKeyType>(type: T, listener: ListenerCallbackFnType<T>): this;
-    off<T extends ListenersKeyType>(type: T, listener: ListenerCallbackFnType<T>): this;
-    emit(type: ListenersKeyType, args: any): boolean;
+    on<T extends ListenersKeyType>(type: T, listener: ListenerCallbackFnType<T>): any;
+    off<T extends ListenersKeyType>(type: T, listener: ListenerCallbackFnType<T>): any;
+    emit(type: ListenersKeyType, args: any): any;
     get sipDomain(): string;
     use(plugin: BaseNewStreamPlugin | BaseProcessStreamPlugin): void;
     getPlugin(name: string): BaseNewStreamPlugin | BaseProcessStreamPlugin;