Skip to content

Chore: Migrate REST API - getRoomMembers to Typescript #3899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexAlexandre merged 2 commits into from
Mar 16, 2022
Merged

Chore: Migrate REST API - getRoomMembers to Typescript #3899

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6edebd6
chore: add rest api return
AlexAlexandre Mar 15, 2022
83163bf
Merge branch 'develop' into chore/getRoomMembers
AlexAlexandre Mar 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions app/definitions/rest/v1/channels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { IServerRoom } from '../../IRoom';
import type { IUser } from '../../IUser';
import { IGetRoomRoles } from '../../IRole';
import { IServerAttachment } from '../../IAttachment';
import { PaginatedRequest } from '../helpers/PaginatedRequest';

export type ChannelsEndpoints = {
'channels.files': {
Expand All @@ -15,12 +16,15 @@ export type ChannelsEndpoints = {
};
};
'channels.members': {
GET: (params: { roomId: IServerRoom['_id']; offset?: number; count?: number; filter?: string; status?: string[] }) => {
count: number;
offset: number;
GET: (params: {
roomId: IServerRoom['_id'];
offset?: number;
count?: number;
filter?: boolean;
status?: string[];
}) => PaginatedRequest<{
members: IUser[];
total: number;
};
}>;
};
'channels.history': {
GET: (params: { roomId: string; count: number; latest?: string }) => {
Expand Down
14 changes: 9 additions & 5 deletions app/definitions/rest/v1/groups.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { IServerRoom } from '../../IRoom';
import type { IUser } from '../../IUser';
import { IGetRoomRoles } from '../../IRole';
import { IServerAttachment } from '../../IAttachment';
import { PaginatedRequest } from '../helpers/PaginatedRequest';

export type GroupsEndpoints = {
'groups.files': {
Expand All @@ -15,12 +16,15 @@ export type GroupsEndpoints = {
};
};
'groups.members': {
GET: (params: { roomId: IServerRoom['_id']; offset?: number; count?: number; filter?: string; status?: string[] }) => {
count: number;
offset: number;
GET: (params: {
roomId: IServerRoom['_id'];
offset?: number;
count?: number;
filter?: string;
status?: string[];
}) => PaginatedRequest<{
members: IUser[];
total: number;
};
}>;
};
'groups.history': {
GET: (params: { roomId: string; count: number; latest?: string }) => {
Expand Down
14 changes: 9 additions & 5 deletions app/definitions/rest/v1/im.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import type { IMessageFromServer } from '../../IMessage';
import type { IServerRoom, RoomID, RoomType } from '../../IRoom';
import type { IUser } from '../../IUser';
import { IServerAttachment } from '../../IAttachment';
import { PaginatedRequest } from '../helpers/PaginatedRequest';

export type ImEndpoints = {
'im.create': {
Expand Down Expand Up @@ -34,12 +35,15 @@ export type ImEndpoints = {
};
};
'im.members': {
GET: (params: { roomId: IServerRoom['_id']; offset?: number; count?: number; filter?: string; status?: string[] }) => {
count: number;
offset: number;
GET: (params: {
roomId: IServerRoom['_id'];
offset?: number;
count?: number;
filter?: string;
status?: string[];
}) => PaginatedRequest<{
members: IUser[];
total: number;
};
}>;
};
'im.history': {
GET: (params: { roomId: string; count: number; latest?: string }) => {
Expand Down
18 changes: 0 additions & 18 deletions app/lib/rocketchat/rocketchat.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,24 +309,6 @@ const RocketChat = {
return sdk.onStreamData(...args);
},
toggleFavorite,
async getRoomMembers({ rid, allUsers, roomType, type, filter, skip = 0, limit = 10 }) {
const serverVersion = reduxStore.getState().server.version;
if (compareServerVersion(serverVersion, 'greaterThanOrEqualTo', '3.16.0')) {
const params = {
roomId: rid,
offset: skip,
count: limit,
...(type !== 'all' && { 'status[]': type }),
...(filter && { filter })
};
// RC 3.16.0
const result = await sdk.get(`${this.roomTypeToApiType(roomType)}.members`, params);
return result?.members;
}
// RC 0.42.0
const result = await this.methodCallWrapper('getUsersOfRoom', rid, allUsers, { skip, limit });
return result?.records;
},
methodCallWrapper(method, ...params) {
return sdk.methodCallWrapper(method, ...params);
},
Expand Down
41 changes: 41 additions & 0 deletions app/lib/rocketchat/services/restApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import { IAvatarSuggestion, IParams } from '../../../definitions/IProfileViewInt
import { Encryption } from '../../encryption';
import { TParams } from '../../../definitions/ILivechatEditView';
import { store as reduxStore } from '../../auxStore';
import { compareServerVersion } from '../../utils';

export const createChannel = ({
name,
Expand Down Expand Up @@ -788,3 +789,43 @@ export const editMessage = async (message: IMessage) => {
// RC 0.49.0
return sdk.post('chat.update', { roomId: rid, msgId: message.id, text: msg });
};

export const getRoomMembers = async ({
rid,
allUsers,
roomType,
type,
filter,
skip = 0,
limit = 10
}: {
rid: string;
allUsers: boolean;
type: 'all' | 'online';
roomType: SubscriptionType;
filter: boolean;
skip: number;
limit: number;
}) => {
const t = roomType as SubscriptionType.CHANNEL | SubscriptionType.GROUP | SubscriptionType.DIRECT;
const serverVersion = reduxStore.getState().server.version;
if (compareServerVersion(serverVersion, 'greaterThanOrEqualTo', '3.16.0')) {
const params = {
roomId: rid,
offset: skip,
count: limit,
...(type !== 'all' && { 'status[]': type }),
...(filter && { filter })
};
// RC 3.16.0
const result = await sdk.get(`${roomTypeToApiType(t)}.members`, params);
if (result.success) {
return result?.members;
}
}
// RC 0.42.0
const result = await sdk.methodCallWrapper('getUsersOfRoom', rid, allUsers, { skip, limit });
if (result.success) {
return result?.records;
}
};