feat(api): migrate users.getPreferences to OpenAPI pattern

.changeset/strong-insects-brush.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/meteor': patch
+---
+
+Migrated users.getPreferences to OpenAPI pattern with AJV validation

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

@@ -2,6 +2,9 @@
 import type { IExportOperation, ILoginToken, IPersonalAccessToken, IUser, UserStatus } from '@rocket.chat/core-typings';
 import { Users, Subscriptions, Sessions } from '@rocket.chat/models';
 import {
+	ajv,
+	validateBadRequestErrorResponse,
+	validateUnauthorizedErrorResponse,
 	isUserCreateParamsPOST,
 	isUserSetActiveStatusParamsPOST,
 	isUserDeactivateIdleParamsPOST,
@@ -18,7 +21,7 @@
 	isUsersSetPreferencesParamsPOST,
 	isUsersCheckUsernameAvailabilityParamsGET,
 	isUsersSendConfirmationEmailParamsPOST,
 	ajv,
 } from '@rocket.chat/rest-typings';
 import { getLoginExpirationInMs, wrapExceptions } from '@rocket.chat/tools';
 import { Accounts } from 'meteor/accounts-base';
@@ -830,25 +833,51 @@
 	},
 );
 
-API.v1.addRoute(
+const UserPreferencesResponseSchema = {
+	type: 'object',
+	properties: {
+		preferences: {
+			type: 'object',
+			additionalProperties: true,
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['preferences', 'success'],
+	additionalProperties: false,
+};
+
+const isUserPreferencesResponse = ajv.compile(UserPreferencesResponseSchema);
+
+const usersEndpoints = API.v1.get(
 	'users.getPreferences',
-	{ authRequired: true },
 	{
-		async get() {
-			const user = await Users.findOneById(this.userId);
-			if (user?.settings) {
-				const { preferences = {} } = user?.settings;
-				preferences.language = user?.language;
-
-				return API.v1.success({
-					preferences,
-				});
-			}
-			return API.v1.failure(i18n.t('Accounts_Default_User_Preferences_not_available').toUpperCase());
+		authRequired: true,
+		response: {
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			200: isUserPreferencesResponse,
 		},
 	},
+	async function action() {
+		const user = await Users.findOneById(this.userId);
+
+		if (user?.settings) {
+			const { preferences = {} } = user.settings;
+			preferences.language = user.language;
+
+			return API.v1.success({ preferences });
+		}
+
+		throw new Meteor.Error('error-preferences-not-found', i18n.t('Accounts_Default_User_Preferences_not_available').toUpperCase());
+	},
 );
 
+export type UsersEndpoints = ExtractRoutesFromAPI<typeof usersEndpoints>;
+
+declare module '@rocket.chat/rest-typings' {
+	type Endpoints = UsersEndpoints;
+}
+
 API.v1.addRoute(
 	'users.forgotPassword',
 	{ authRequired: false },
@@ -1501,7 +1530,7 @@
 	API.v1.updateRateLimiterDictionaryForRoute(userRegisterRoute, value);
 });
 
 type UsersEndpoints = ExtractRoutesFromAPI<typeof usersEndpoints>;
 
 declare module '@rocket.chat/rest-typings' {
 	// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface