refactor: migrate rooms.favorite endpoint to new OpenAPI pattern with AJV validation

.changeset/migrate-rooms-favorite-endpoint.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/meteor': patch
+---
+
+Migrated rooms.favorite endpoint to new OpenAPI pattern with AJV validation

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

@@ -311,26 +311,52 @@ API.v1.addRoute(
 	},
 );
 
-API.v1.addRoute(
+export const roomsFavoriteEndpoint = API.v1.post(
 	'rooms.favorite',
-	{ authRequired: true },
 	{
-		async post() {
-			const { favorite } = this.bodyParams;
-
-			if (!this.bodyParams.hasOwnProperty('favorite')) {
-				return API.v1.failure("The 'favorite' param is required");
-			}
-
-			const room = await findRoomByIdOrName({ params: this.bodyParams });
+		authRequired: true,
+		body: ajv.compile<
+			{
+				favorite: boolean;
+			} & ({ roomId: string } | { roomName: string })
+		>({
+			type: 'object',
+			properties: {
+				roomId: { type: 'string', minLength: 1 },
+				roomName: { type: 'string', minLength: 1 },
+				favorite: { type: 'boolean' },
+			},
+			oneOf: [{ required: ['roomId', 'favorite'] }, { required: ['roomName', 'favorite'] }],
+			additionalProperties: false,
+		}),
+		response: {
+			200: ajv.compile({
+				type: 'object',
+				properties: { success: { type: 'boolean', enum: [true] } },
+				required: ['success'],
+				additionalProperties: false,
+			}),
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+		},
+	},
+	async function action() {
+		const { favorite } = this.bodyParams;
+		const room = await findRoomByIdOrName({ params: this.bodyParams });
 
-			await toggleFavoriteMethod(this.userId, room._id, favorite);
+		await toggleFavoriteMethod(this.userId, room._id, favorite);
 
-			return API.v1.success();
-		},
+		return API.v1.success();
 	},
 );
 
+type RoomsFavoriteEndpoint = ExtractRoutesFromAPI<typeof roomsFavoriteEndpoint>;
+
+declare module '@rocket.chat/rest-typings' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface
+	interface Endpoints extends RoomsFavoriteEndpoint {}
+}
+
 API.v1.addRoute(
 	'rooms.cleanHistory',
 	{ authRequired: true, validateParams: isRoomsCleanHistoryProps },

packages/rest-typings/src/v1/rooms.ts

@@ -805,20 +805,6 @@ export type RoomsEndpoints = {
 		POST: (params: { roomId: string; notifications: Notifications }) => void;
 	};
 
-	'/v1/rooms.favorite': {
-		POST: (
-			params:
-				| {
-						roomId: string;
-						favorite: boolean;
-				  }
-				| {
-						roomName: string;
-						favorite: boolean;
-				  },
-		) => void;
-	};
-
 	'/v1/rooms.nameExists': {
 		GET: (params: { roomName: string }) => {
 			exists: boolean;