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

.vscode/settings.json

@@ -17,4 +17,4 @@
 		"tmid",
 		"tshow"
 	]
-}
+}

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

@@ -1,7 +1,10 @@
 import { MeteorError, Team, api, Calendar } from '@rocket.chat/core-services';
+
 import type { IExportOperation, ILoginToken, IPersonalAccessToken, IUser, UserStatus } from '@rocket.chat/core-typings';
 import { Users, Subscriptions, Sessions } from '@rocket.chat/models';
 import {
+
+
 	isUserCreateParamsPOST,
 	isUserSetActiveStatusParamsPOST,
 	isUserDeactivateIdleParamsPOST,
@@ -171,9 +174,9 @@ API.v1.addRoute(
 			const twoFactorOptions = !userData.typedPassword
 				? null
 				: {
-						twoFactorCode: userData.typedPassword,
-						twoFactorMethod: 'password',
-					};
+					twoFactorCode: userData.typedPassword,
+					twoFactorMethod: 'password',
+				};
 
 			await executeSaveUserProfile.call(this, this.user, userData, this.bodyParams.customFields, twoFactorOptions);
 
@@ -536,10 +539,10 @@ API.v1.addRoute(
 			const limit =
 				count !== 0
 					? [
-							{
-								$limit: count,
-							},
-						]
+						{
+							$limit: count,
+						},
+					]
 					: [];
 
 			const result = await Users.col
@@ -752,6 +755,21 @@ 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
 	.post(
 		'users.createToken',
@@ -877,26 +895,32 @@ const usersEndpoints = API.v1
 
 			return API.v1.success({ suggestions });
 		},
-	);
-
-API.v1.addRoute(
-	'users.getPreferences',
-	{ authRequired: true },
-	{
-		async get() {
+	)
+	.get(
+		'users.getPreferences',
+		{
+			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;
+				const { preferences = {} } = user.settings;
+				preferences.language = user.language;
 
-				return API.v1.success({
-					preferences,
-				});
+				return API.v1.success({ preferences });
 			}
-			return API.v1.failure(i18n.t('Accounts_Default_User_Preferences_not_available').toUpperCase());
+
+			throw new Meteor.Error('error-preferences-not-found', i18n.t('Accounts_Default_User_Preferences_not_available').toUpperCase());
 		},
-	},
-);
+	);
+
+export type UsersEndpoints = ExtractRoutesFromAPI<typeof usersEndpoints>;
 
 API.v1.addRoute(
 	'users.forgotPassword',
@@ -1554,9 +1578,7 @@ settings.watch<number>('Rate_Limiter_Limit_RegisterUser', (value) => {
 	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
-	interface Endpoints extends UsersEndpoints {}
+	interface Endpoints extends UsersEndpoints { }
 }