[IMPROVE] teams.list endpoint doesn't support queries

app/api/server/v1/teams.ts

@@ -8,8 +8,9 @@ import { Rooms, Subscriptions } from '../../../models/server';
 API.v1.addRoute('teams.list', { authRequired: true }, {
 	get() {
 		const { offset, count } = this.getPaginationItems();
+		const { sort, query } = this.parseJsonQuery();
 
-		const { records, total } = Promise.await(Team.list(this.userId, { offset, count }));
+		const { records, total } = Promise.await(Team.list(this.userId, { offset, count }, { sort, query }));
 
 		return API.v1.success({
 			teams: records,

app/models/server/raw/Team.ts

@@ -1,4 +1,4 @@
-import { Collection, FindOneOptions, Cursor, UpdateWriteOpResult, DeleteWriteOpResultObject } from 'mongodb';
+import { Collection, FindOneOptions, Cursor, UpdateWriteOpResult, DeleteWriteOpResultObject, FilterQuery } from 'mongodb';
 
 import { BaseRaw } from './BaseRaw';
 import { ITeam } from '../../../../definition/ITeam';
@@ -22,8 +22,8 @@ export class TeamRaw extends BaseRaw<T> {
 		return this.col.find({ name: { $in: names } }, options);
 	}
 
-	findByIds(ids: Array<string>, options?: FindOneOptions<T>): Cursor<T> {
-		return this.col.find({ _id: { $in: ids } }, options);
+	findByIds(ids: Array<string>, options?: FindOneOptions<T>, query?: FilterQuery<T>): Cursor<T> {
+		return this.col.find({ _id: { $in: ids }, ...query }, options);
 	}
 
 	findByIdsAndType(ids: Array<string>, type: number, options?: FindOneOptions<T>): Cursor<T> {

definition/ITeam.ts

@@ -1,3 +1,5 @@
+import { SortOptionObject, FilterQuery, SchemaMember } from 'mongodb';
+
 import { IRocketChatRecord } from './IRocketChatRecord';
 import { IUser } from './IUser';
 
@@ -6,6 +8,8 @@ export enum TEAM_TYPE {
 	PRIVATE = 1,
 }
 
+export type SortType = -1|1;
+
 export interface ITeam extends IRocketChatRecord {
 	name: string;
 	type: TEAM_TYPE;
@@ -28,6 +32,13 @@ export interface IPaginationOptions {
 	count: number;
 }
 
+// TODO move this definition to a more broader file
+export interface IQueryOptions<T> {
+	sort: SortOptionObject<T>;
+	query?: FilterQuery<T>;
+	fields?: SchemaMember<T, number | boolean>;
+}
+
 // TODO move this definition to a more broader file
 export interface IRecordsWithTotal<T> {
 	records: Array<T>;

server/sdk/types/ITeamService.ts

@@ -1,6 +1,6 @@
 import { FindOneOptions } from 'mongodb';
 
-import { ITeam, IRecordsWithTotal, IPaginationOptions } from '../../../definition/ITeam';
+import { ITeam, IRecordsWithTotal, IPaginationOptions, IQueryOptions } from '../../../definition/ITeam';
 import { IRoom } from '../../../definition/IRoom';
 import { ICreateRoomParams } from './IRoomService';
 
@@ -46,7 +46,7 @@ export interface ITeamService {
 	removeRoom(uid: string, rid: string, teamId: string, canRemoveAnyRoom: boolean): Promise<IRoom>;
 	listRooms(uid: string, teamId: string, getAllRooms: boolean, allowPrivateTeam: boolean, pagination: IPaginationOptions): Promise<IRecordsWithTotal<IRoom>>;
 	updateRoom(uid: string, rid: string, isDefault: boolean, canUpdateAnyRoom: boolean): Promise<IRoom>;
-	list(uid: string, options?: IPaginationOptions): Promise<IRecordsWithTotal<ITeam>>;
+	list(uid: string, paginationOptions?: IPaginationOptions, queryOptions?: IQueryOptions<ITeam>): Promise<IRecordsWithTotal<ITeam>>;
 	listAll(options?: IPaginationOptions): Promise<IRecordsWithTotal<ITeam>>;
 	listByNames(names: Array<string>, options?: FindOneOptions<ITeam>): Promise<Array<ITeam>>;
 	search(userId: string, term: string | RegExp, options?: FindOneOptions<ITeam>): Promise<ITeam[]>;

server/services/team/service.ts

@@ -1,7 +1,7 @@
 import { Db, FindOneOptions } from 'mongodb';
 
 import { TeamRaw } from '../../../app/models/server/raw/Team';
-import { ITeam, ITeamMember, TEAM_TYPE, IRecordsWithTotal, IPaginationOptions, ITeamStats } from '../../../definition/ITeam';
+import { ITeam, ITeamMember, TEAM_TYPE, IRecordsWithTotal, IPaginationOptions, IQueryOptions, ITeamStats } from '../../../definition/ITeam';
 import { Room } from '../../sdk';
 import { ITeamCreateParams, ITeamInfo, ITeamMemberInfo, ITeamMemberParams, ITeamService } from '../../sdk/types/ITeamService';
 import { IUser } from '../../../definition/IUser';
@@ -175,7 +175,7 @@ export class TeamService extends ServiceClass implements ITeamService {
 		return this.TeamModel.findByNameAndTeamIds(term, teamIds, options).toArray();
 	}
 
-	async list(uid: string, { offset, count }: IPaginationOptions = { offset: 0, count: 50 }): Promise<IRecordsWithTotal<ITeamInfo>> {
+	async list(uid: string, { offset, count }: IPaginationOptions = { offset: 0, count: 50 }, { sort, query }: IQueryOptions<ITeam> = { sort: {} }): Promise<IRecordsWithTotal<ITeamInfo>> {
 		const userTeams = await this.TeamMembersModel.findByUserId(uid, { projection: { teamId: 1 } }).toArray();
 
 		const teamIds = userTeams.map(({ teamId }) => teamId);
@@ -187,9 +187,10 @@ export class TeamService extends ServiceClass implements ITeamService {
 		}
 
 		const cursor = this.TeamModel.findByIds(teamIds, {
+			sort,
 			limit: count,
 			skip: offset,
-		});
+		}, query);
 
 		const records = await cursor.toArray();
 		const results: ITeamInfo[] = [];