chore(api): migrate channels.ts to typed HTTP methods

apps/meteor/server/api/v1/channels.ts

@@ -29,6 +29,9 @@ import {
 	isChannelsListProps,
 	isChannelsFilesListProps,
 	isChannelsOnlineProps,
+	ajv,
+	validateBadRequestErrorResponse,
+	validateUnauthorizedErrorResponse,
 } from '@rocket.chat/rest-typings';
 import { isTruthy } from '@rocket.chat/tools';
 import { check, Match } from 'meteor/check';
@@ -106,14 +109,44 @@ async function findChannelByIdOrName({
 	return room;
 }
 
-API.v1.addRoute(
+const channelResponseSchema = ajv.compile<{ channel: IRoom }>({
+	type: 'object',
+	properties: {
+		channel: { $ref: '#/components/schemas/IRoom' },
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['channel', 'success'],
+	additionalProperties: false,
+});
+
+const successResponseSchema = ajv.compile<void>({
+	type: 'object',
+	properties: { success: { type: 'boolean', enum: [true] } },
+	required: ['success'],
+	additionalProperties: false,
+});
+
+// findChannelByIdOrName and the room methods throw for client errors. The typed router does not map thrown
+// errors to 400 (the legacy addRoute wrapper did), so handlers catch and return a failure. Errors coming from
+// core-services cross a boundary and are not `instanceof Meteor.Error`, so extract message/errorType by shape.
+function errorToFailureArgs(error: unknown): [string, string | undefined] {
+	const e = error as { message?: unknown; error?: unknown };
+	return [typeof e?.message === 'string' ? e.message : String(error), typeof e?.error === 'string' ? e.error : undefined];
+}
+
+API.v1.post(
 	'channels.addAll',
 	{
 		authRequired: true,
-		validateParams: isChannelsAddAllProps,
+		body: isChannelsAddAllProps,
+		response: {
+			200: channelResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+		},
 	},
-	{
-		async post() {
+	async function action() {
+		try {
 			const { activeUsersOnly, ...params } = this.bodyParams;
 			const findResult = await findChannelByIdOrName({ params, userId: this.userId });
 
@@ -122,35 +155,51 @@ API.v1.addRoute(
 			return API.v1.success({
 				channel: await findChannelByIdOrName({ params, userId: this.userId }),
 			});
-		},
+		} catch (error) {
+			const [message, errorType] = errorToFailureArgs(error);
+			return API.v1.failure(message, errorType);
+		}
 	},
 );
 
-API.v1.addRoute(
+API.v1.post(
 	'channels.archive',
 	{
 		authRequired: true,
-		validateParams: isChannelsArchiveProps,
+		body: isChannelsArchiveProps,
+		response: {
+			200: successResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+		},
 	},
-	{
-		async post() {
+	async function action() {
+		try {
 			const findResult = await findChannelByIdOrName({ params: this.bodyParams });
 
 			await executeArchiveRoom(this.userId, findResult._id);
 
 			return API.v1.success();
-		},
+		} catch (error) {
+			const [message, errorType] = errorToFailureArgs(error);
+			return API.v1.failure(message, errorType);
+		}
 	},
 );
 
-API.v1.addRoute(
+API.v1.post(
 	'channels.unarchive',
 	{
 		authRequired: true,
-		validateParams: isChannelsUnarchiveProps,
+		body: isChannelsUnarchiveProps,
+		response: {
+			200: successResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+		},
 	},
-	{
-		async post() {
+	async function action() {
+		try {
 			const findResult = await findChannelByIdOrName({
 				params: this.bodyParams,
 				checkedArchived: false,
@@ -163,7 +212,10 @@ API.v1.addRoute(
 			await executeUnarchiveRoom(this.userId, findResult._id);
 
 			return API.v1.success();
-		},
+		} catch (error) {
+			const [message, errorType] = errorToFailureArgs(error);
+			return API.v1.failure(message, errorType);
+		}
 	},
 );
 
@@ -223,14 +275,19 @@ API.v1.addRoute(
 	},
 );
 
-API.v1.addRoute(
+API.v1.post(
 	'channels.join',
 	{
 		authRequired: true,
-		validateParams: isChannelsJoinProps,
+		body: isChannelsJoinProps,
+		response: {
+			200: channelResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+		},
 	},
-	{
-		async post() {
+	async function action() {
+		try {
 			const { joinCode, ...params } = this.bodyParams;
 			const findResult = await findChannelByIdOrName({ params });
 
@@ -239,18 +296,26 @@ API.v1.addRoute(
 			return API.v1.success({
 				channel: await findChannelByIdOrName({ params, userId: this.userId }),
 			});
-		},
+		} catch (error) {
+			const [message, errorType] = errorToFailureArgs(error);
+			return API.v1.failure(message, errorType);
+		}
 	},
 );
 
-API.v1.addRoute(
+API.v1.post(
 	'channels.kick',
 	{
 		authRequired: true,
-		validateParams: isChannelsKickProps,
+		body: isChannelsKickProps,
+		response: {
+			200: channelResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+		},
 	},
-	{
-		async post() {
+	async function action() {
+		try {
 			const { ...params /* userId */ } = this.bodyParams;
 			const findResult = await findChannelByIdOrName({ params });
 
@@ -264,18 +329,26 @@ API.v1.addRoute(
 			return API.v1.success({
 				channel: await findChannelByIdOrName({ params, userId: this.userId }),
 			});
-		},
+		} catch (error) {
+			const [message, errorType] = errorToFailureArgs(error);
+			return API.v1.failure(message, errorType);
+		}
 	},
 );
 
-API.v1.addRoute(
+API.v1.post(
 	'channels.leave',
 	{
 		authRequired: true,
-		validateParams: isChannelsLeaveProps,
+		body: isChannelsLeaveProps,
+		response: {
+			200: channelResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+		},
 	},
-	{
-		async post() {
+	async function action() {
+		try {
 			const { ...params } = this.bodyParams;
 			const findResult = await findChannelByIdOrName({ params });
 
@@ -288,7 +361,10 @@ API.v1.addRoute(
 			return API.v1.success({
 				channel: await findChannelByIdOrName({ params, userId: this.userId }),
 			});
-		},
+		} catch (error) {
+			const [message, errorType] = errorToFailureArgs(error);
+			return API.v1.failure(message, errorType);
+		}
 	},
 );