feat: Room List Bridge

.changeset/chatty-dingos-bathe.md

@@ -0,0 +1,7 @@
+---
+'@rocket.chat/apps-engine': minor
+'@rocket.chat/apps': minor
+'@rocket.chat/meteor': minor
+---
+
+Adds a new method to the Apps-Engine that allows apps to retrieve multiple rooms from database

apps/meteor/app/apps/server/bridges/rooms.ts

@@ -1,9 +1,9 @@
 import type { IAppServerOrchestrator } from '@rocket.chat/apps';
 import type { IMessage, IMessageRaw } from '@rocket.chat/apps-engine/definition/messages';
-import type { IRoom } from '@rocket.chat/apps-engine/definition/rooms';
+import type { IRoom, IRoomRaw } from '@rocket.chat/apps-engine/definition/rooms';
 import { RoomType } from '@rocket.chat/apps-engine/definition/rooms';
 import type { IUser } from '@rocket.chat/apps-engine/definition/users';
-import type { GetMessagesOptions } from '@rocket.chat/apps-engine/server/bridges/RoomBridge';
+import type { GetMessagesOptions, GetRoomsFilters, GetRoomsOptions } from '@rocket.chat/apps-engine/server/bridges/RoomBridge';
 import { RoomBridge } from '@rocket.chat/apps-engine/server/bridges/RoomBridge';
 import type { ISubscription, IUser as ICoreUser, IRoom as ICoreRoom, IMessage as ICoreMessage } from '@rocket.chat/core-typings';
 import { Subscriptions, Users, Rooms, Messages } from '@rocket.chat/models';
@@ -17,6 +17,41 @@ import { removeUserFromRoom } from '../../../lib/server/functions/removeUserFrom
 import { createChannelMethod } from '../../../lib/server/methods/createChannel';
 import { createPrivateGroupMethod } from '../../../lib/server/methods/createPrivateGroup';
 
+const rawRoomProjection: FindOptions<ICoreRoom>['projection'] = {
+	_id: 1,
+	fname: 1,
+	name: 1,
+	usernames: 1,
+	members: 1,
+	uids: 1,
+	default: 1,
+	ro: 1,
+	sysMes: 1,
+	msgs: 1,
+	ts: 1,
+	_updatedAt: 1,
+	closedAt: 1,
+	lm: 1,
+	description: 1,
+	customFields: 1,
+	prid: 1,
+	teamId: 1,
+	teamMain: 1,
+	livechatData: 1,
+	waitingResponse: 1,
+	open: 1,
+	source: 1,
+	closer: 1,
+	t: 1,
+	u: 1,
+	v: 1,
+	contactId: 1,
+	departmentId: 1,
+	closedBy: 1,
+	servedBy: 1,
+	responseBy: 1,
+};
+
 export class AppRoomBridge extends RoomBridge {
 	constructor(private readonly orch: IAppServerOrchestrator) {
 		super();
@@ -151,6 +186,37 @@ export class AppRoomBridge extends RoomBridge {
 		return promises as Promise<IUser[]>;
 	}
 
+	protected async getAllRooms(filters: GetRoomsFilters = {}, options: GetRoomsOptions = {}, appId: string): Promise<Array<IRoomRaw>> {
+		this.orch.debugLog(`The App ${appId} is getting all rooms with options`, options);
+
+		const { limit = 100, skip = 0 } = options;
+
+		const findOptions: FindOptions<ICoreRoom> = {
+			sort: { ts: -1 },
+			skip,
+			limit: Math.min(limit, 100),
+			projection: rawRoomProjection,
+		};
+
+		const { types, discussions, teams } = filters;
+
+		const rooms: IRoomRaw[] = [];
+
+		const roomConverter = this.orch.getConverters()?.get('rooms');
+		if (!roomConverter) {
+			throw new Error('Room converter not found');
+		}
+
+		for await (const room of Rooms.findAllByTypesAndDiscussionAndTeam({ types, discussions, teams }, findOptions)) {
+			const converted = await roomConverter.convertRoomRaw(room);
+			if (converted) {
+				rooms.push(converted);
+			}
+		}
+
+		return rooms;
+	}
+
 	protected async getDirectByUsernames(usernames: Array<string>, appId: string): Promise<IRoom | undefined> {
 		this.orch.debugLog(`The App ${appId} is getting direct room by usernames: "${usernames}"`);
 		const room = await Rooms.findDirectRoomContainingAllUsernames(usernames, {});

apps/meteor/app/apps/server/converters/rooms.js

@@ -20,6 +20,106 @@ export class AppRoomsConverter {
 		return this.convertRoom(room);
 	}
 
+	convertRoomRaw(room) {
+		if (!room) {
+			return undefined;
+		}
+
+		const mapUserLookup = (user) =>
+			user && {
+				_id: user._id ?? user.id,
+				...(user.username && { username: user.username }),
+				...(user.name && { name: user.name }),
+			};
+
+		const map = {
+			id: '_id',
+			displayName: 'fname',
+			slugifiedName: 'name',
+			members: 'members',
+			userIds: 'uids',
+			usernames: 'usernames',
+			messageCount: 'msgs',
+			createdAt: 'ts',
+			updatedAt: '_updatedAt',
+			closedAt: 'closedAt',
+			lastModifiedAt: 'lm',
+			customFields: 'customFields',
+			livechatData: 'livechatData',
+			isWaitingResponse: 'waitingResponse',
+			isOpen: 'open',
+			description: 'description',
+			source: 'source',
+			closer: 'closer',
+			teamId: 'teamId',
+			isTeamMain: 'teamMain',
+			isDefault: 'default',
+			isReadOnly: 'ro',
+			contactId: 'contactId',
+			departmentId: 'departmentId',
+			parentRoomId: 'prid',
+			visitor: (data) => {
+				const { v } = data;
+				if (!v) {
+					return undefined;
+				}
+
+				delete data.v;
+
+				const { _id: id, ...rest } = v;
+
+				return {
+					id,
+					...rest,
+				};
+			},
+			displaySystemMessages: (data) => {
+				const { sysMes } = data;
+				delete data.sysMes;
+				return typeof sysMes === 'undefined' ? true : sysMes;
+			},
+			type: (data) => {
+				const result = this._convertTypeToApp(data.t);
+				delete data.t;
+				return result;
+			},
+			creator: (data) => {
+				if (!data.u) {
+					return undefined;
+				}
+				const creator = mapUserLookup(data.u);
+				delete data.u;
+				return creator;
+			},
+			closedBy: (data) => {
+				if (!data.closedBy) {
+					return undefined;
+				}
+				const { closedBy } = data;
+				delete data.closedBy;
+				return mapUserLookup(closedBy);
+			},
+			servedBy: (data) => {
+				if (!data.servedBy) {
+					return undefined;
+				}
+				const { servedBy } = data;
+				delete data.servedBy;
+				return mapUserLookup(servedBy);
+			},
+			responseBy: (data) => {
+				if (!data.responseBy) {
+					return undefined;
+				}
+				const { responseBy } = data;
+				delete data.responseBy;
+				return mapUserLookup(responseBy);
+			},
+		};
+
+		return transformMappedData(room, map);
+	}
+
 	async __getCreator(user) {
 		if (!user) {
 			return;
@@ -54,6 +154,7 @@ export class AppRoomsConverter {
 			username: visitor.username,
 			token: visitor.token,
 			status: visitor.status || 'online',
+			activity: visitor.activity,
 			...(lastMessageTs && { lastMessageTs }),
 			...(phone && { phone }),
 		};
@@ -200,6 +301,8 @@ export class AppRoomsConverter {
 			description: 'description',
 			source: 'source',
 			closer: 'closer',
+			teamId: 'teamId',
+			isTeamMain: 'teamMain',
 			isDefault: (room) => {
 				const result = !!room.default;
 				delete room.default;

apps/meteor/app/apps/server/converters/visitors.js

@@ -36,6 +36,7 @@ export class AppVisitorsConverter {
 			visitorEmails: 'visitorEmails',
 			livechatData: 'livechatData',
 			status: 'status',
+			activity: 'activity',
 		};
 
 		return transformMappedData(visitor, map);

packages/apps-engine/src/definition/accessors/IRoomRead.ts

@@ -1,6 +1,6 @@
-import type { GetMessagesOptions } from '../../server/bridges/RoomBridge';
+import type { GetMessagesOptions, GetRoomsFilters, GetRoomsOptions } from '../../server/bridges/RoomBridge';
 import type { IMessageRaw } from '../messages/index';
-import type { IRoom } from '../rooms/index';
+import type { IRoom, IRoomRaw } from '../rooms/index';
 import type { IUser } from '../users/index';
 
 /**
@@ -61,6 +61,13 @@ export interface IRoomRead {
 	 */
 	getMembers(roomId: string): Promise<Array<IUser>>;
 
+	/**
+	 * Retrieves rooms in the workspace, optionally filtered by type and whether they are discussions or part of teams.
+	 *
+	 * @returns a list of raw rooms, or undefined if the app does not have the permission to view all rooms
+	 */
+	getAllRooms(filters?: GetRoomsFilters, options?: GetRoomsOptions): Promise<Array<IRoomRaw> | undefined>;
+
 	/**
 	 * Gets a direct room with all usernames
 	 * @param usernames all usernames belonging to the direct room

packages/apps-engine/src/definition/livechat/IVisitor.ts

@@ -11,6 +11,7 @@ export interface IVisitor {
 	phone?: Array<IVisitorPhone>;
 	visitorEmails?: Array<IVisitorEmail>;
 	status?: string;
+	activity?: string[];
 	customFields?: { [key: string]: any };
 	livechatData?: { [key: string]: any };
 }

packages/apps-engine/src/definition/rooms/IRoom.ts

@@ -7,6 +7,8 @@ export interface IRoom {
 	slugifiedName: string;
 	type: RoomType;
 	creator: IUser;
+	teamId?: string;
+	isTeamMain?: boolean;
 	/**
 	 * @deprecated usernames will be removed on version 2.0.0
 	 */

packages/apps-engine/src/definition/rooms/IRoomRaw.ts

@@ -0,0 +1,43 @@
+import type { IVisitor } from '../livechat';
+import type { IOmnichannelSource, IVisitorChannelInfo } from '../livechat/ILivechatRoom';
+import type { IUserLookup } from '../users';
+import type { RoomType } from './RoomType';
+
+/**
+ * A lightweight representation of a room without resolving relational data.
+ * This is intended for listing operations to avoid additional database lookups.
+ */
+export interface IRoomRaw {
+	id: string;
+	slugifiedName: string;
+	displayName?: string;
+	type: RoomType;
+	creator?: IUserLookup;
+	members?: Array<string>;
+	userIds?: Array<string>;
+	usernames?: Array<string>;
+	isDefault?: boolean;
+	isReadOnly?: boolean;
+	displaySystemMessages?: boolean;
+	messageCount?: number;
+	createdAt?: Date;
+	updatedAt?: Date;
+	closedAt?: Date;
+	lastModifiedAt?: Date;
+	description?: string;
+	customFields?: { [key: string]: any };
+	parentRoomId?: string;
+	teamId?: string;
+	isTeamMain?: boolean;
+	livechatData?: { [key: string]: any };
+	isWaitingResponse?: boolean;
+	isOpen?: boolean;
+	closer?: 'user' | 'visitor' | 'bot';
+	closedBy?: IUserLookup;
+	servedBy?: IUserLookup;
+	responseBy?: IUserLookup;
+	source?: IOmnichannelSource;
+	visitor?: Pick<IVisitor, 'id' | 'token' | 'username' | 'name' | 'status' | 'activity'> & IVisitorChannelInfo;
+	departmentId?: string;
+	contactId?: string;
+}

packages/apps-engine/src/definition/rooms/index.ts

@@ -5,10 +5,12 @@ import { IPreRoomCreateModify } from './IPreRoomCreateModify';
 import { IPreRoomCreatePrevent } from './IPreRoomCreatePrevent';
 import { IPreRoomDeletePrevent } from './IPreRoomDeletePrevent';
 import { IRoom } from './IRoom';
+import { IRoomRaw } from './IRoomRaw';
 import { RoomType } from './RoomType';
 
 export {
 	IRoom,
+	IRoomRaw,
 	RoomType,
 	IPostRoomCreate,
 	IPostRoomDeleted,

packages/apps-engine/src/server/accessors/RoomRead.ts

@@ -1,9 +1,9 @@
 import type { IRoomRead } from '../../definition/accessors';
 import type { IMessageRaw } from '../../definition/messages';
-import type { IRoom } from '../../definition/rooms';
+import type { IRoom, IRoomRaw } from '../../definition/rooms';
 import type { IUser } from '../../definition/users';
 import type { RoomBridge } from '../bridges';
-import { type GetMessagesOptions, GetMessagesSortableFields } from '../bridges/RoomBridge';
+import { type GetMessagesOptions, type GetRoomsFilters, type GetRoomsOptions, GetMessagesSortableFields } from '../bridges/RoomBridge';
 
 export class RoomRead implements IRoomRead {
 	constructor(
@@ -46,6 +46,22 @@ export class RoomRead implements IRoomRead {
 		return this.roomBridge.doGetMembers(roomId, this.appId);
 	}
 
+	public getAllRooms(filters: GetRoomsFilters = {}, { limit = 100, skip = 0 }: GetRoomsOptions = {}): Promise<Array<IRoomRaw> | undefined> {
+		if (!Number.isFinite(limit) || limit <= 0 || limit > 100) {
+			throw new Error(`Invalid limit provided. Expected number between 1 and 100, got ${limit}`);
+		}
+
+		if (!Number.isFinite(skip) || skip < 0) {
+			throw new Error(`Invalid skip provided. Expected number >= 0, got ${skip}`);
+		}
+
+		return this.roomBridge.doGetAllRooms(
+			filters,
+			{ limit, skip },
+			this.appId,
+		);
+	}
+
 	public getDirectByUsernames(usernames: Array<string>): Promise<IRoom> {
 		return this.roomBridge.doGetDirectByUsernames(usernames, this.appId);
 	}