refactor: migrate groups.delete to new architecture

.changeset/thirty-deers-fail.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/rest-typings': minor
+'@rocket.chat/meteor': minor
+---
+
+Migrate groups.delete endpoint to the new REST API architecture

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

@@ -1,7 +1,14 @@
 import { Team, isMeteorError } from '@rocket.chat/core-services';
 import type { IIntegration, IUser, IRoom, RoomType, UserStatus } from '@rocket.chat/core-typings';
 import { Integrations, Messages, Rooms, Subscriptions, Uploads, Users } from '@rocket.chat/models';
-import { isGroupsOnlineProps, isGroupsMessagesProps, isGroupsFilesProps } from '@rocket.chat/rest-typings';
+import {
+	ajv,
+	isGroupsOnlineProps,
+	isGroupsMessagesProps,
+	isGroupsFilesProps,
+	validateBadRequestErrorResponse,
+	validateUnauthorizedErrorResponse,
+} from '@rocket.chat/rest-typings';
 import { isTruthy } from '@rocket.chat/tools';
 import { check, Match } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
@@ -31,6 +38,7 @@ import { executeGetRoomRoles } from '../../../lib/server/methods/getRoomRoles';
 import { leaveRoomMethod } from '../../../lib/server/methods/leaveRoom';
 import { executeUnarchiveRoom } from '../../../lib/server/methods/unarchiveRoom';
 import { normalizeMessagesForUser } from '../../../utils/server/lib/normalizeMessagesForUser';
+import type { ExtractRoutesFromAPI } from '../ApiClass';
 import { API } from '../api';
 import { addUserToFileObj } from '../helpers/addUserToFileObj';
 import { composeRoomWithLastMessage } from '../helpers/composeRoomWithLastMessage';
@@ -67,7 +75,7 @@ async function getRoomFromParams(params: { roomId?: string } | { roomName?: stri
 		}
 	})();
 
-	if (!room || room.t !== 'p') {
+	if (room?.t !== 'p') {
 		throw new Meteor.Error('error-room-not-found', 'The required "roomId" or "roomName" param provided does not match any group');
 	}
 
@@ -273,7 +281,7 @@ API.v1.addRoute(
 				room = await Rooms.findOneByName(params.roomName || '');
 			}
 
-			if (!room || room.t !== 'p') {
+			if (room?.t !== 'p') {
 				throw new Meteor.Error('error-room-not-found', 'The required "roomId" or "roomName" param provided does not match any group');
 			}
 
@@ -368,21 +376,69 @@ API.v1.addRoute(
 	},
 );
 
-API.v1.addRoute(
+const GroupsDeletePropsSchema = {
+	oneOf: [
+		{
+			type: 'object',
+			properties: {
+				roomId: {
+					type: 'string',
+					description: 'Enter the room ID. This parameter is required if no roomName is provided.',
+				},
+			},
+			required: ['roomId'],
+			additionalProperties: false,
+		},
+		{
+			type: 'object',
+			properties: {
+				roomName: {
+					type: 'string',
+					description: 'Enter the room name. This parameter is required if no roomId is provided.',
+				},
+			},
+			required: ['roomName'],
+			additionalProperties: false,
+		},
+	],
+} as const;
+
+type GroupsDeleteProps = { roomId: string } | { roomName: string };
+
+const isGroupsDeleteProps = ajv.compile<GroupsDeleteProps>(GroupsDeletePropsSchema);
+
+const groupDeleteEndpoint = API.v1.post(
 	'groups.delete',
-	{ authRequired: true },
 	{
-		async post() {
-			const findResult = await findPrivateGroupByIdOrName({
-				params: this.bodyParams,
-				userId: this.userId,
-				checkedArchived: false,
-			});
+		authRequired: true,
+		body: isGroupsDeleteProps,
+		response: {
+			200: ajv.compile<{ success: true }>({
+				type: 'object',
+				properties: {
+					success: {
+						type: 'boolean',
+						enum: [true],
+						description: 'Indicates if the request was successful.',
+					},
+				},
+				required: ['success'],
+				additionalProperties: false,
+			}),
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+		},
+	},
+	async function action() {
+		const findResult = await findPrivateGroupByIdOrName({
+			params: this.bodyParams,
+			userId: this.userId,
+			checkedArchived: false,
+		});
 
-			await eraseRoom(findResult.rid, this.user);
+		await eraseRoom(findResult.rid, this.user);
 
-			return API.v1.success();
-		},
+		return API.v1.success();
 	},
 );
 
@@ -791,7 +847,7 @@ API.v1.addRoute(
 				rid: findResult.rid,
 				...parseIds(mentionIds, 'mentions._id'),
 				...parseIds(starredIds, 'starred._id'),
-				...(pinned && pinned.toLowerCase() === 'true' ? { pinned: true } : {}),
+				...(pinned?.toLowerCase() === 'true' ? { pinned: true } : {}),
 				_hidden: { $ne: true },
 			};
 
@@ -1300,3 +1356,10 @@ API.v1.addRoute(
 		},
 	},
 );
+
+type GroupEndpoints = ExtractRoutesFromAPI<typeof groupDeleteEndpoint>;
+
+declare module '@rocket.chat/rest-typings' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface
+	interface Endpoints extends GroupEndpoints {}
+}

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

@@ -9,7 +9,6 @@ import type { GroupsCloseProps } from './GroupsCloseProps';
 import type { GroupsConvertToTeamProps } from './GroupsConvertToTeamProps';
 import type { GroupsCountersProps } from './GroupsCountersProps';
 import type { GroupsCreateProps } from './GroupsCreateProps';
-import type { GroupsDeleteProps } from './GroupsDeleteProps';
 import type { GroupsFilesProps } from './GroupsFilesProps';
 import type { GroupsGetIntegrationsProps } from './GroupsGetIntegrationsProps';
 import type { GroupsHistoryProps } from './GroupsHistoryProps';
@@ -90,9 +89,6 @@ export type GroupsEndpoints = {
 	'/v1/groups.kick': {
 		POST: (params: GroupsKickProps) => void;
 	};
-	'/v1/groups.delete': {
-		POST: (params: GroupsDeleteProps) => void;
-	};
 	'/v1/groups.leave': {
 		POST: (params: GroupsLeaveProps) => void;
 	};

packages/rest-typings/src/v1/groups/index.ts

@@ -5,7 +5,6 @@ export * from './GroupsCloseProps';
 export * from './GroupsConvertToTeamProps';
 export * from './GroupsCreateProps';
 export * from './GroupsCountersProps';
-export * from './GroupsDeleteProps';
 export * from './GroupsFilesProps';
 export * from './GroupsKickProps';
 export * from './GroupsLeaveProps';