@flashphoner/sfusdk 2.0.279 → 2.0.284

package/dist/sdk/sfu-extended.js

@@ -95,6 +95,8 @@ class SfuExtended {
      * @param options.username - The user's username (optional if `authToken` is provided).
      * @param options.password - The user's password (optional if `authToken` is provided).
      * @param options.authToken - The authentication token for direct login (optional if `username` and `password` are provided).
+     *
+     * After successfully connection user contacts will receive an {@link SfuEvent.USER_PRESENCE_STATUS_UPDATED} with {@link UserPresenceStatusUpdated}
      */
     connect(options) {
         if (!options) {
@@ -147,6 +149,8 @@ class SfuExtended {
      * When disconnecting, user leaves all active rooms
      *
      * {@link state} changed to {@link State.DISCONNECTED | DISCONNECTED}
+     *
+     * After disconnection user contacts will receive an {@link SfuEvent.USER_PRESENCE_STATUS_UPDATED} with {@link UserPresenceStatusUpdated}
      */
     disconnect() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -752,84 +756,100 @@ class SfuExtended {
         });
     }
     /**
-     * Get all users from server
+     * Get user contacts.
+     *
+     * Returns users who are friends or with whom there are mutual space channels or direct chats, incoming and outgoing friend invites, banned users.
      */
-    getUserList() {
+    getContacts() {
         __classPrivateFieldGet(this, _SfuExtended_instances, "m", _SfuExtended_checkAuthenticated).call(this);
         const self = this;
         return new Promise(function (resolve, reject) {
-            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.GET_USER_LIST, {}, resolve, reject);
+            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.GET_CONTACTS, {}, resolve, reject);
         });
     }
     ;
     /**
-     * Invite user to contacts
+     * Add a friend
      *
-     * UserId must be passed if user exist. That user will receive {@link SfuEvent.CONTACT_INVITE} with {@link Invite}
+     * Sends a friend invite.
+     * Users will receive {@link SfuEvent.NEW_OUTGOING_FRIEND_INVITE} and {@link SfuEvent.NEW_INCOMING_FRIEND_INVITE} with {@link NewFriendInvite}.
      *
-     * UserEmail must be passed if there is no such user yet. In this case user will be created at the server side with {@link UserState.PENDING_REGISTRATION} and default parameters
+     * If an invite was sent to this user previously, it will be replaced with a new one.
+     * Users will receive {@link SfuEvent.OUTGOING_FRIEND_INVITE_DELETED} and {@link SfuEvent.INCOMING_FRIEND_INVITE_DELETED} with {@link FriendInviteDeleted} for previously invite.
+     * Users will receive {@link SfuEvent.NEW_OUTGOING_FRIEND_INVITE} and {@link SfuEvent.NEW_INCOMING_FRIEND_INVITE} with {@link NewFriendInvite} for new friend invite.
+     *
+     * If the user that you are trying to add as a friend has already sent you an invite, sending a counter-invite will automatically add you as friends.
+     * Users will receive {@link SfuEvent.OUTGOING_FRIEND_INVITE_DELETED} and {@link SfuEvent.INCOMING_FRIEND_INVITE_DELETED} with {@link FriendInviteDeleted} for invites.
+     * Users will receive {@link SfuEvent.CONTACT_UPDATED} with {@link ContactUpdated} if they have mutual space channels or direct chats.
+     * Will receive {@link SfuEvent.NEW_CONTACT} with {@link NewContact} if haven't.
      */
-    inviteContact(invite) {
+    addFriend(user) {
         __classPrivateFieldGet(this, _SfuExtended_instances, "m", _SfuExtended_checkAuthenticated).call(this);
         const self = this;
         return new Promise(function (resolve, reject) {
-            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.INVITE_CONTACT, { from: __classPrivateFieldGet(self, _SfuExtended__user, "f").username, to: invite.to }, resolve, reject);
+            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.ADD_FRIEND, {
+                userId: user.userId,
+            }, resolve, reject);
         });
     }
     /**
-     * Add contact to favourites
+     * Remove friend
      *
-     * {@link User.favourite} will be changed to true at the server side
+     * Users will receive {@link SfuEvent.CONTACT_UPDATED} with {@link ContactUpdated} if they have mutual space channels or direct chats.
+     * Will receive {@link SfuEvent.CONTACT_DELETED} with {@link ContactDeleted} if haven't.
      */
-    addContactToFavourites(contact) {
+    removeFriend(friend) {
         __classPrivateFieldGet(this, _SfuExtended_instances, "m", _SfuExtended_checkAuthenticated).call(this);
         const self = this;
         return new Promise(function (resolve, reject) {
-            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.ADD_CONTACT_TO_FAVOURITES, { id: contact.id }, resolve, reject);
+            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.REMOVE_FRIEND, {
+                userId: friend.userId,
+            }, resolve, reject);
         });
     }
     /**
-     * Remove contact from favourites
+     * Revoke friend invite
      *
-     * {@link User.favourite} will be changed to false at the server side
+     * Users will receive {@link SfuEvent.OUTGOING_FRIEND_INVITE_DELETED} and {@link SfuEvent.INCOMING_FRIEND_INVITE_DELETED} with {@link FriendInviteDeleted}.
      */
-    removeContactFromFavourites(contact) {
+    revokeFriendInvite(invite) {
         __classPrivateFieldGet(this, _SfuExtended_instances, "m", _SfuExtended_checkAuthenticated).call(this);
         const self = this;
         return new Promise(function (resolve, reject) {
-            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.REMOVE_CONTACT_FROM_FAVOURITES, { id: contact.id }, resolve, reject);
+            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.REVOKE_FRIEND_INVITE, {
+                inviteId: invite.inviteId,
+            }, resolve, reject);
         });
     }
     /**
-     * Confirm contact
-     *
-     * {@link User.confirmed} will be changed to true for both users.
+     * Accept friend invite
      *
-     * @param invite.from - user with that userId will receive {@link SfuEvent.CONTACT_UPDATE} with {@link User}
+     * Users will receive {@link SfuEvent.OUTGOING_FRIEND_INVITE_DELETED} and {@link SfuEvent.INCOMING_FRIEND_INVITE_DELETED} with {@link FriendInviteDeleted} for invites.
+     * Users will receive {@link SfuEvent.CONTACT_UPDATED} with {@link ContactUpdated} if they have mutual space channels or direct chats.
+     * Will receive {@link SfuEvent.NEW_CONTACT} with {@link NewContact} if haven't.
      */
-    confirmContact(invite) {
+    acceptFriendInvite(invite) {
         __classPrivateFieldGet(this, _SfuExtended_instances, "m", _SfuExtended_checkAuthenticated).call(this);
         const self = this;
         return new Promise(function (resolve, reject) {
-            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.CONFIRM_CONTACT, {
-                from: invite.from,
-                to: invite.to,
-                id: invite.id
+            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.ACCEPT_FRIEND_INVITE, {
+                inviteId: invite.inviteId,
             }, resolve, reject);
         });
     }
     /**
-     * Confirm contact
+     * Reject friend invite
      *
-     * {@link User.confirmed} will be changed to true for both users.
-     *
-     * @param contact.id - user with that userId will receive {@link SfuEvent.CONTACT_REMOVED} with {@link User}
+     * Promise will resolve with {@link SfuEvent.INCOMING_FRIEND_INVITE_DELETED} with {@link FriendInviteDeleted}.
+     * Outgoing friend invite will not delete.
      */
-    removeContact(contact) {
+    rejectFriendInvite(invite) {
         __classPrivateFieldGet(this, _SfuExtended_instances, "m", _SfuExtended_checkAuthenticated).call(this);
         const self = this;
         return new Promise(function (resolve, reject) {
-            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.REMOVE_CONTACT, { id: contact.id }, resolve, reject);
+            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.REJECT_FRIEND_INVITE, {
+                inviteId: invite.inviteId,
+            }, resolve, reject);
         });
     }
     /**
@@ -989,6 +1009,49 @@ class SfuExtended {
         });
     }
     ;
+    /**
+     * Update presence status
+     *
+     * Friends and users with whom there are mutual space channels or direct chats will receive {@link SfuEvent.USER_PRESENCE_STATUS_UPDATED} with {@link UserPresenceStatusUpdated}.
+     * The selected status is saved and will persist across subsequent connects. It can be retrieved using the {@link getUserInfo}.
+     */
+    updatePresenceStatus(status) {
+        __classPrivateFieldGet(this, _SfuExtended_instances, "m", _SfuExtended_checkAuthenticated).call(this);
+        const self = this;
+        return new Promise(function (resolve, reject) {
+            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.UPDATE_PRESENCE_STATUS, {
+                status: status
+            }, resolve, reject);
+        });
+    }
+    ;
+    /**
+     * Update user activity
+     *
+     * Working with selected {@link PresenceStatus.ONLINE} by {@link updatePresenceStatus}.
+     * Does not work with other statuses.
+     *
+     * The user client that called this method will receive {@link UserInfoChangedEvent} with {@link PresenceStatus.ONLINE} or {@link PresenceStatus.IDLE}.
+     * Other user clients will not receive events.
+     *
+     * {@param isActive} = false:
+     * If the user hasn't other connected active clients then user contacts will receive {@link UserPresenceStatusUpdated} with {@link PresenceStatus.IDLE}.
+     * If the user has other connected active clients then user contacts will not receive events.
+     *
+     * {@param isActive} = true:
+     * If all user clients was inactive then user contacts will receive {@link UserPresenceStatusUpdated} with {@link PresenceStatus.ONLINE}.
+     * If the user has at least one active connected client, then the contacts will not receive any events.
+     */
+    updateActivityStatus(isActive) {
+        __classPrivateFieldGet(this, _SfuExtended_instances, "m", _SfuExtended_checkAuthenticated).call(this);
+        const self = this;
+        return new Promise(function (resolve, reject) {
+            __classPrivateFieldGet(self, _SfuExtended_instances, "m", _SfuExtended_emmitAction).call(self, constants_1.InternalApi.UPDATE_ACTIVITY_STATUS, {
+                isActive
+            }, resolve, reject);
+        });
+    }
+    ;
     /**
      * @deprecated
      */
@@ -1915,11 +1978,6 @@ _SfuExtended_connection = new WeakMap(), _SfuExtended__user = new WeakMap(), _Sf
                         __classPrivateFieldGet(this, _SfuExtended_downloadingAttachmentState, "f").push(Object.assign(Object.assign({}, request), { payload: null, internalMessageId: ack.internalMessageId }));
                     }
                 }
-                else if (data[0].type === constants_1.InternalApi.USER_LIST) {
-                    const userList = data[0];
-                    promises_1.default.resolve(data[0].internalMessageId, userList.list);
-                    __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.USER_LIST, userList.list);
-                }
                 else if (data[0].type === constants_1.InternalApi.USER_CALENDAR) {
                     const calendar = data[0];
                     promises_1.default.resolve(data[0].internalMessageId, calendar.calendar);
@@ -1961,24 +2019,6 @@ _SfuExtended_connection = new WeakMap(), _SfuExtended__user = new WeakMap(), _Sf
                         __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.NEW_CHAT, chatInfo.info);
                     }
                 }
-                else if (data[0].type === constants_1.InternalApi.CONTACT_INVITE) {
-                    const invite = data[0];
-                    if (!promises_1.default.resolve(data[0].internalMessageId, invite.invite)) {
-                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.CONTACT_INVITE, invite.invite);
-                    }
-                }
-                else if (data[0].type === constants_1.InternalApi.CONTACT_UPDATED) {
-                    const contact = data[0];
-                    if (!promises_1.default.resolve(data[0].internalMessageId, contact.contact)) {
-                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.CONTACT_UPDATE, contact.contact);
-                    }
-                }
-                else if (data[0].type === constants_1.InternalApi.CONTACT_REMOVED) {
-                    const contact = data[0];
-                    if (!promises_1.default.resolve(data[0].internalMessageId, contact.contact)) {
-                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.CONTACT_REMOVED, contact.contact);
-                    }
-                }
                 else if (data[0].type === constants_1.InternalApi.CHAT_DELETED) {
                     const chat = data[0];
                     if (!promises_1.default.resolve(data[0].internalMessageId, chat.info)) {
@@ -2386,6 +2426,60 @@ _SfuExtended_connection = new WeakMap(), _SfuExtended__user = new WeakMap(), _Sf
                     const event = data[0];
                     __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.MeetingSyncEvent.MEETING_NAME_UPDATED_SYNC, event);
                 }
+                else if (data[0].type === constants_1.SfuEvent.USER_CONTACTS) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event.contacts)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.USER_CONTACTS, event);
+                    }
+                }
+                else if (data[0].type === constants_1.SfuEvent.NEW_CONTACT) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event.contact)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.NEW_CONTACT, event);
+                    }
+                }
+                else if (data[0].type === constants_1.SfuEvent.CONTACT_UPDATED) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event.contact)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.CONTACT_UPDATED, event);
+                    }
+                }
+                else if (data[0].type === constants_1.SfuEvent.CONTACT_DELETED) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.CONTACT_DELETED, event);
+                    }
+                }
+                else if (data[0].type === constants_1.SfuEvent.NEW_INCOMING_FRIEND_INVITE) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.NEW_INCOMING_FRIEND_INVITE, event);
+                    }
+                }
+                else if (data[0].type === constants_1.SfuEvent.NEW_OUTGOING_FRIEND_INVITE) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.NEW_OUTGOING_FRIEND_INVITE, event);
+                    }
+                }
+                else if (data[0].type === constants_1.SfuEvent.INCOMING_FRIEND_INVITE_DELETED) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.INCOMING_FRIEND_INVITE_DELETED, event);
+                    }
+                }
+                else if (data[0].type === constants_1.SfuEvent.OUTGOING_FRIEND_INVITE_DELETED) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.OUTGOING_FRIEND_INVITE_DELETED, event);
+                    }
+                }
+                else if (data[0].type === constants_1.SfuEvent.USER_PRESENCE_STATUS_UPDATED) {
+                    const event = data[0];
+                    if (!promises_1.default.resolve(data[0].internalMessageId, event)) {
+                        __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(constants_1.SfuEvent.USER_PRESENCE_STATUS_UPDATED, event);
+                    }
+                }
                 else {
                     __classPrivateFieldGet(this, _SfuExtended_notifier, "f").notify(data[0].type, data[0]);
                 }