feat: Apps-Engine method to read multiple messages from a room

.changeset/polite-foxes-repair.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/meteor': minor
+---
+
+Added a method to the Apps-Engine that allows apps to read multiple messages from a room

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

@@ -1,11 +1,11 @@
 import type { IAppServerOrchestrator } from '@rocket.chat/apps';
-import type { IMessage } from '@rocket.chat/apps-engine/definition/messages';
+import type { IMessage, IMessageRaw } from '@rocket.chat/apps-engine/definition/messages';
 import type { IRoom } 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 { RoomBridge } from '@rocket.chat/apps-engine/server/bridges/RoomBridge';
 import type { ISubscription, IUser as ICoreUser, IRoom as ICoreRoom } from '@rocket.chat/core-typings';
-import { Subscriptions, Users, Rooms } from '@rocket.chat/models';
+import { Subscriptions, Users, Rooms, Messages } from '@rocket.chat/models';
 
 import { createDirectMessage } from '../../../../server/methods/createDirectMessage';
 import { createDiscussion } from '../../../discussion/server/methods/createDiscussion';
@@ -102,6 +102,55 @@ export class AppRoomBridge extends RoomBridge {
 		return this.orch.getConverters()?.get('users').convertById(room.u._id);
 	}
 
+	protected async getMessages(
+		roomId: string,
+		options: {
+			limit: number;
+			skip?: number;
+			sort?: Record<string, 1 | -1>;
+		},
+		appId: string,
+	): Promise<IMessageRaw[]> {
+		this.orch.debugLog(`The App ${appId} is getting the messages of the room: "${roomId}"`);
+
+		let { limit, skip = 0, sort } = options;
+
+		if (!Number.isFinite(limit) || limit < 1) {
+			limit = 100;
+		}
+
+		if (!Number.isFinite(skip) || skip < 0) {
+			skip = 0;
+		}
+
+		if (!sort || typeof sort !== 'object') {
+			sort = { ts: -1 };
+		}
+
+		const messageConverter = this.orch.getConverters()?.get('messages');
+		if (!messageConverter) {
+			throw new Error('Message converter not found');
+		}
+
+		const messageQueryOptions = {
+			limit: Math.min(limit, 100),
+			skip,
+			sort,
+		};
+
+		const query = {
+			rid: roomId,
+			_hidden: { $ne: true },
+			t: { $exists: false },
+		};
+
+		const cursor = Messages.find(query, messageQueryOptions);
+
+		const messagePromises: Promise<IMessageRaw>[] = await cursor.map((message) => messageConverter.convertMessageRaw(message)).toArray();
+
+		return Promise.all(messagePromises);
+	}
+
 	protected async getMembers(roomId: string, appId: string): Promise<Array<IUser>> {
 		this.orch.debugLog(`The App ${appId} is getting the room's members by room id: "${roomId}"`);
 		const subscriptions = await Subscriptions.findByRoomId(roomId, {});

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

@@ -14,6 +14,40 @@ export class AppMessagesConverter {
 		return this.convertMessage(msg);
 	}
 
+	async convertMessageRaw(msgObj) {
+		if (!msgObj) {
+			return undefined;
+		}
+
+		const { attachments, ...message } = msgObj;
+		const getAttachments = async () => this._convertAttachmentsToApp(attachments);
+
+		const map = {
+			id: '_id',
+			threadId: 'tmid',
+			reactions: 'reactions',
+			parseUrls: 'parseUrls',
+			text: 'msg',
+			createdAt: 'ts',
+			updatedAt: '_updatedAt',
+			editedAt: 'editedAt',
+			emoji: 'emoji',
+			avatarUrl: 'avatar',
+			alias: 'alias',
+			file: 'file',
+			customFields: 'customFields',
+			groupable: 'groupable',
+			token: 'token',
+			blocks: 'blocks',
+			room: 'rid',
+			editor: 'editedBy',
+			attachments: getAttachments,
+			sender: 'u',
+		};
+
+		return transformMappedData(message, map);
+	}
+
 	async convertMessage(msgObj) {
 		if (!msgObj) {
 			return undefined;

apps/meteor/ee/server/services/package.json

@@ -18,7 +18,7 @@
 	"author": "Rocket.Chat",
 	"license": "MIT",
 	"dependencies": {
-		"@rocket.chat/apps-engine": "1.42.2",
+		"@rocket.chat/apps-engine": "1.43.0-alpha.754",
 		"@rocket.chat/core-services": "workspace:^",
 		"@rocket.chat/core-typings": "workspace:^",
 		"@rocket.chat/emitter": "~0.31.25",

apps/meteor/package.json

@@ -231,7 +231,7 @@
 		"@rocket.chat/agenda": "workspace:^",
 		"@rocket.chat/api-client": "workspace:^",
 		"@rocket.chat/apps": "workspace:^",
-		"@rocket.chat/apps-engine": "1.42.2",
+		"@rocket.chat/apps-engine": "1.43.0-alpha.754",
 		"@rocket.chat/base64": "workspace:^",
 		"@rocket.chat/cas-validate": "workspace:^",
 		"@rocket.chat/core-services": "workspace:^",

ee/apps/ddp-streamer/package.json

@@ -15,7 +15,7 @@
 	],
 	"author": "Rocket.Chat",
 	"dependencies": {
-		"@rocket.chat/apps-engine": "1.42.2",
+		"@rocket.chat/apps-engine": "1.43.0-alpha.754",
 		"@rocket.chat/core-services": "workspace:^",
 		"@rocket.chat/core-typings": "workspace:^",
 		"@rocket.chat/emitter": "~0.31.25",

ee/packages/presence/package.json

@@ -6,7 +6,7 @@
 		"@babel/core": "~7.22.20",
 		"@babel/preset-env": "~7.22.20",
 		"@babel/preset-typescript": "~7.22.15",
-		"@rocket.chat/apps-engine": "1.42.2",
+		"@rocket.chat/apps-engine": "1.43.0-alpha.754",
 		"@rocket.chat/eslint-config": "workspace:^",
 		"@rocket.chat/rest-typings": "workspace:^",
 		"@types/node": "^14.18.63",

packages/apps/package.json

@@ -22,7 +22,7 @@
 		"/dist"
 	],
 	"dependencies": {
-		"@rocket.chat/apps-engine": "1.42.2",
+		"@rocket.chat/apps-engine": "1.43.0-alpha.754",
 		"@rocket.chat/core-typings": "workspace:^",
 		"@rocket.chat/model-typings": "workspace:^"
 	}

packages/apps/src/AppsEngine.ts

@@ -8,6 +8,7 @@ export type {
 	IVisitorPhone as IAppsVisitorPhone,
 } from '@rocket.chat/apps-engine/definition/livechat';
 export type { IMessage as IAppsMessage } from '@rocket.chat/apps-engine/definition/messages';
+export type { IMessageRaw as IAppsMesssageRaw } from '@rocket.chat/apps-engine/definition/messages';
 export { AppInterface as AppEvents } from '@rocket.chat/apps-engine/definition/metadata';
 export type { IUser as IAppsUser } from '@rocket.chat/apps-engine/definition/users';
 export type { IRole as IAppsRole } from '@rocket.chat/apps-engine/definition/roles';

packages/apps/src/converters/IAppMessagesConverter.ts

@@ -1,6 +1,6 @@
 import type { IMessage } from '@rocket.chat/core-typings';
 
-import type { IAppsMessage } from '../AppsEngine';
+import type { IAppsMessage, IAppsMesssageRaw } from '../AppsEngine';
 
 export interface IAppMessagesConverter {
 	convertById(messageId: IMessage['_id']): Promise<IAppsMessage | undefined>;
@@ -10,4 +10,6 @@ export interface IAppMessagesConverter {
 	convertAppMessage(message: undefined | null): Promise<undefined>;
 	convertAppMessage(message: IAppsMessage): Promise<IMessage | undefined>;
 	convertAppMessage(message: IAppsMessage | undefined | null): Promise<IMessage | undefined>;
+	convertMessageRaw(message: IMessage): Promise<IAppsMesssageRaw>;
+	convertMessageRaw(message: IMessage | undefined | null): Promise<IAppsMesssageRaw | undefined>;
 }

packages/core-services/package.json

@@ -34,7 +34,7 @@
 		"extends": "../../package.json"
 	},
 	"dependencies": {
-		"@rocket.chat/apps-engine": "1.42.2",
+		"@rocket.chat/apps-engine": "1.43.0-alpha.754",
 		"@rocket.chat/core-typings": "workspace:^",
 		"@rocket.chat/icons": "^0.36.0",
 		"@rocket.chat/message-parser": "workspace:^",

packages/core-typings/package.json

@@ -22,7 +22,7 @@
 		"/dist"
 	],
 	"dependencies": {
-		"@rocket.chat/apps-engine": "1.42.2",
+		"@rocket.chat/apps-engine": "1.43.0-alpha.754",
 		"@rocket.chat/icons": "^0.36.0",
 		"@rocket.chat/message-parser": "workspace:^",
 		"@rocket.chat/ui-kit": "workspace:~"

packages/fuselage-ui-kit/package.json

@@ -63,7 +63,7 @@
     "@babel/preset-env": "~7.22.20",
     "@babel/preset-react": "~7.22.15",
     "@babel/preset-typescript": "~7.22.15",
-    "@rocket.chat/apps-engine": "^1.42.2",
+    "@rocket.chat/apps-engine": "1.43.0-alpha.754",
     "@rocket.chat/core-typings": "workspace:^",
     "@rocket.chat/eslint-config": "workspace:^",
     "@rocket.chat/fuselage": "^0.54.2",

packages/rest-typings/package.json

@@ -24,7 +24,7 @@
 		"/dist"
 	],
 	"dependencies": {
-		"@rocket.chat/apps-engine": "1.42.2",
+		"@rocket.chat/apps-engine": "1.43.0-alpha.754",
 		"@rocket.chat/core-typings": "workspace:^",
 		"@rocket.chat/message-parser": "workspace:^",
 		"@rocket.chat/ui-kit": "workspace:~",

yarn.lock

@@ -8340,9 +8340,9 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@rocket.chat/apps-engine@npm:1.42.2, @rocket.chat/apps-engine@npm:^1.42.2":
-  version: 1.42.2
-  resolution: "@rocket.chat/apps-engine@npm:1.42.2"
+"@rocket.chat/apps-engine@npm:1.43.0-alpha.754":
+  version: 1.43.0-alpha.754
+  resolution: "@rocket.chat/apps-engine@npm:1.43.0-alpha.754"
   dependencies:
     adm-zip: ^0.5.9
     cryptiles: ^4.1.3
@@ -8354,15 +8354,15 @@ __metadata:
     vm2: ^3.9.19
   peerDependencies:
     "@rocket.chat/ui-kit": "*"
-  checksum: d7aa23249823e37072b6b7af16a40d9a4e7cb6b8047f2a87e52163dfe516d6c8a09b21cafd4f28dfbe4dd3da9cd0190d71f7623fec8c573a3f215ca4f9529b56
+  checksum: 59b1d9b4485cf5a9ba4072d07c4221d26de64a539acbfdd911d724cd582658247022094596da14b7029033a8129af2097190e086ce1f52bb7f298bb95fdccdb7
   languageName: node
   linkType: hard
 
 "@rocket.chat/apps@workspace:^, @rocket.chat/apps@workspace:packages/apps":
   version: 0.0.0-use.local
   resolution: "@rocket.chat/apps@workspace:packages/apps"
   dependencies:
-    "@rocket.chat/apps-engine": 1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/core-typings": "workspace:^"
     "@rocket.chat/model-typings": "workspace:^"
     "@types/jest": ~29.5.7
@@ -8441,7 +8441,7 @@ __metadata:
     "@babel/core": ~7.22.20
     "@babel/preset-env": ~7.22.20
     "@babel/preset-typescript": ~7.22.15
-    "@rocket.chat/apps-engine": 1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/core-typings": "workspace:^"
     "@rocket.chat/eslint-config": "workspace:^"
     "@rocket.chat/icons": ^0.36.0
@@ -8467,7 +8467,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@rocket.chat/core-typings@workspace:packages/core-typings"
   dependencies:
-    "@rocket.chat/apps-engine": 1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/eslint-config": "workspace:^"
     "@rocket.chat/icons": ^0.36.0
     "@rocket.chat/message-parser": "workspace:^"
@@ -8544,7 +8544,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@rocket.chat/ddp-streamer@workspace:ee/apps/ddp-streamer"
   dependencies:
-    "@rocket.chat/apps-engine": 1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/core-services": "workspace:^"
     "@rocket.chat/core-typings": "workspace:^"
     "@rocket.chat/emitter": ~0.31.25
@@ -8740,7 +8740,7 @@ __metadata:
     "@babel/preset-env": ~7.22.20
     "@babel/preset-react": ~7.22.15
     "@babel/preset-typescript": ~7.22.15
-    "@rocket.chat/apps-engine": ^1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/core-typings": "workspace:^"
     "@rocket.chat/eslint-config": "workspace:^"
     "@rocket.chat/fuselage": ^0.54.2
@@ -9184,7 +9184,7 @@ __metadata:
     "@rocket.chat/agenda": "workspace:^"
     "@rocket.chat/api-client": "workspace:^"
     "@rocket.chat/apps": "workspace:^"
-    "@rocket.chat/apps-engine": 1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/base64": "workspace:^"
     "@rocket.chat/cas-validate": "workspace:^"
     "@rocket.chat/core-services": "workspace:^"
@@ -9822,7 +9822,7 @@ __metadata:
     "@babel/core": ~7.22.20
     "@babel/preset-env": ~7.22.20
     "@babel/preset-typescript": ~7.22.15
-    "@rocket.chat/apps-engine": 1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/core-services": "workspace:^"
     "@rocket.chat/core-typings": "workspace:^"
     "@rocket.chat/eslint-config": "workspace:^"
@@ -9937,7 +9937,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@rocket.chat/rest-typings@workspace:packages/rest-typings"
   dependencies:
-    "@rocket.chat/apps-engine": 1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/core-typings": "workspace:^"
     "@rocket.chat/eslint-config": "workspace:^"
     "@rocket.chat/message-parser": "workspace:^"
@@ -36853,7 +36853,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "rocketchat-services@workspace:apps/meteor/ee/server/services"
   dependencies:
-    "@rocket.chat/apps-engine": 1.42.2
+    "@rocket.chat/apps-engine": 1.43.0-alpha.754
     "@rocket.chat/core-services": "workspace:^"
     "@rocket.chat/core-typings": "workspace:^"
     "@rocket.chat/emitter": ~0.31.25