[WIP] feat: add endpoints groups.membersOrderedByRole channels.membersOrderedByRole

[abhinavkrin]

Proposed changes (including videos or screenshots)

Adds groups.membersOrderedByRole and channels.membersOrderedByRole endpoints to retrieve members of groups and channels sorted according to their respective role in the room.
This will help in grouping of users according to their roles in the room like below.

The endpoint works similar as groups.members and channels.members, but accepts an optional rolesOrder[] param which can be used for defining roles order while sorting. The index of the role will signify its priority. By default, owner > moderator > rest of members.

A sample request

curl --location --globoff 'http://localhost:3000/api/v1/channels.membersOrderedByRole?roomId=GENERAL&sort={%22username%22%3A%201}&offset=0&rolesOrder[]=leader&rolesOrder[]=owner' \
--header 'X-Auth-Token: Ce_2eOJ19mnW59wVO5IfSv4s650MF1w7mqY6i52uPG5' \
--header 'X-User-Id: u29m4aQNjZujdE4r5' \
--data ''

Issue(s)

Steps to test or reproduce

Further comments

CORE-846

[dionisio-bot]

Looks like this PR is not ready to merge, because of the following issues:

• This PR is missing the 'stat: QA assured' label

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

[changeset-bot]

🦋 Changeset detected

Latest commit: 7c92475

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 35 packages

Name	Type
@rocket.chat/meteor	Patch
@rocket.chat/rest-typings	Patch
@rocket.chat/api-client	Patch
@rocket.chat/core-services	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/ui-contexts	Patch
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/stream-hub-service	Patch
@rocket.chat/omnichannel-services	Patch
@rocket.chat/presence	Patch
rocketchat-services	Patch
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/network-broker	Patch
@rocket.chat/livechat	Patch
@rocket.chat/uikit-playground	Patch
@rocket.chat/fuselage-ui-kit	Patch
@rocket.chat/gazzodown	Patch
@rocket.chat/ui-avatar	Patch
@rocket.chat/ui-client	Patch
@rocket.chat/ui-video-conf	Patch
@rocket.chat/ui-voip	Patch
@rocket.chat/web-ui-registration	Patch
@rocket.chat/core-typings	Patch
@rocket.chat/apps	Patch
@rocket.chat/cron	Patch
@rocket.chat/freeswitch	Patch
@rocket.chat/model-typings	Patch
@rocket.chat/license	Patch
@rocket.chat/pdf-worker	Patch
@rocket.chat/models	Patch
@rocket.chat/instance-status	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

PR Preview Action v1.4.8
🚀 Deployed preview to https://RocketChat.github.io/Rocket.Chat/pr-preview/pr-34153/
on branch gh-pages at 2024-12-13 18:05 UTC

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.79%. Comparing base (75643e1) to head (df876a0).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop   #34153   +/-   ##
========================================
  Coverage    75.79%   75.79%           
========================================
  Files          511      511           
  Lines        22132    22132           
  Branches      5394     5394           
========================================
  Hits         16775    16775           
  Misses        4709     4709           
  Partials       648      648           

Flag	Coverage Δ
unit	75.79% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.