refactor(chat): migrate chat.syncThreadMessages to typed REST endpoint

apps/meteor/app/api/server/v1/calendar.ts

@@ -1,3 +1,4 @@
+/*
 import { Calendar } from '@rocket.chat/core-services';
 import type { ICalendarEvent } from '@rocket.chat/core-typings';
 import {
@@ -222,3 +223,4 @@ API.v1.post(
 		return API.v1.success();
 	},
 );
+*/

apps/meteor/app/api/server/v1/chat.ts

@@ -275,6 +275,44 @@ const isChatPinMessageProps = ajv.compile<ChatPinMessage>(ChatPinMessageSchema);
 
 const isChatUnpinMessageProps = ajv.compile<ChatUnpinMessage>(ChatUnpinMessageSchema);
 
+const isSyncThreadMessagesResponse = ajv.compile<{
+  messages: {
+    update: Partial<IMessage>[];
+    remove: Partial<IMessage>[];
+  };
+}>({
+  type: 'object',
+  properties: {
+    messages: {
+      type: 'object',
+      properties: {
+        update: {
+          type: 'array',
+          items: {
+            type: 'object',
+            additionalProperties: true,
+          },
+        },
+        remove: {
+          type: 'array',
+          items: {
+            type: 'object',
+            additionalProperties: true,
+          },
+        },
+      },
+      required: ['update', 'remove'],
+      additionalProperties: false,
+    },
+    success: {
+      type: 'boolean',
+      enum: [true],
+    },
+  },
+  required: ['messages', 'success'],
+  additionalProperties: false,
+});
+
 const chatEndpoints = API.v1
 	.post(
 		'chat.pinMessage',
@@ -558,6 +596,51 @@ const chatEndpoints = API.v1
 
 			return API.v1.success();
 		},
+	)
+	.get(
+		'chat.syncThreadMessages',
+		{
+			authRequired: true,
+			query: isChatSyncThreadMessagesProps,
+			response: {
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+				200: isSyncThreadMessagesResponse,
+			},
+		},
+		async function action() {
+			const { tmid } = this.queryParams;
+			const { query, fields, sort } = await this.parseJsonQuery();
+			const { updatedSince } = this.queryParams;
+			let updatedSinceDate;
+			if (!settings.get<boolean>('Threads_enabled')) {
+				throw new Meteor.Error('error-not-allowed', 'Threads Disabled');
+			}
+
+			if (isNaN(Date.parse(updatedSince))) {
+				throw new Meteor.Error('error-updatedSince-param-invalid', 'The "updatedSince" query parameter must be a valid date.');
+			} else {
+				updatedSinceDate = new Date(updatedSince);
+			}
+			const thread = await Messages.findOneById(tmid, { projection: { rid: 1 } });
+			if (!thread?.rid) {
+				throw new Meteor.Error('error-invalid-message', 'Invalid Message');
+			}
+			const [user, room] = await Promise.all([
+				Users.findOneById(this.userId, { projection: { _id: 1 } }),
+				Rooms.findOneById(thread.rid, { projection: { ...roomAccessAttributes, t: 1, _id: 1 } }),
+			]);
+
+			if (!room || !user || !(await canAccessRoomAsync(room, user))) {
+				throw new Meteor.Error('error-not-allowed', 'Not Allowed');
+			}
+			return API.v1.success({
+				messages: {
+					update: await Messages.find({ ...query, tmid, _updatedAt: { $gt: updatedSinceDate } }, { projection: fields, sort }).toArray(),
+					remove: await Messages.trashFindDeletedAfter(updatedSinceDate, { ...query, tmid }, { projection: fields, sort }).toArray(),
+				},
+			});
+		},
 	);
 
 API.v1.addRoute(
@@ -918,45 +1001,6 @@ API.v1.addRoute(
 	},
 );
 
-API.v1.addRoute(
-	'chat.syncThreadMessages',
-	{ authRequired: true, validateParams: isChatSyncThreadMessagesProps },
-	{
-		async get() {
-			const { tmid } = this.queryParams;
-			const { query, fields, sort } = await this.parseJsonQuery();
-			const { updatedSince } = this.queryParams;
-			let updatedSinceDate;
-			if (!settings.get<boolean>('Threads_enabled')) {
-				throw new Meteor.Error('error-not-allowed', 'Threads Disabled');
-			}
-
-			if (isNaN(Date.parse(updatedSince))) {
-				throw new Meteor.Error('error-updatedSince-param-invalid', 'The "updatedSince" query parameter must be a valid date.');
-			} else {
-				updatedSinceDate = new Date(updatedSince);
-			}
-			const thread = await Messages.findOneById(tmid, { projection: { rid: 1 } });
-			if (!thread?.rid) {
-				throw new Meteor.Error('error-invalid-message', 'Invalid Message');
-			}
-			// TODO: promise.all? this.user?
-			const user = await Users.findOneById(this.userId, { projection: { _id: 1 } });
-			const room = await Rooms.findOneById(thread.rid, { projection: { ...roomAccessAttributes, t: 1, _id: 1 } });
-
-			if (!room || !user || !(await canAccessRoomAsync(room, user))) {
-				throw new Meteor.Error('error-not-allowed', 'Not Allowed');
-			}
-			return API.v1.success({
-				messages: {
-					update: await Messages.find({ ...query, tmid, _updatedAt: { $gt: updatedSinceDate } }, { projection: fields, sort }).toArray(),
-					remove: await Messages.trashFindDeletedAfter(updatedSinceDate, { ...query, tmid }, { projection: fields, sort }).toArray(),
-				},
-			});
-		},
-	},
-);
-
 API.v1.addRoute(
 	'chat.getMentionedMessages',
 	{ authRequired: true, validateParams: isChatGetMentionedMessagesProps },