Chore: Convert users endpoints (#25635)

Co-authored-by: Guilherme Gazzo <guilherme@gazzo.xyz> Co-authored-by: Tasso Evangelista <tasso.evangelista@rocket.chat>
RocketChat · Jun 17, 2022 · 6b6f9dc · 6b6f9dc
1 parent 2c05ffd
commit 6b6f9dc
Show file tree

Hide file tree

Showing 23 changed files with 1,370 additions and 669 deletions.
diff --git a/apps/meteor/app/api/server/api.d.ts b/apps/meteor/app/api/server/api.d.ts
@@ -9,7 +9,7 @@ import type {
 } from '@rocket.chat/rest-typings';
 import type { IUser, IMethodConnection, IRoom } from '@rocket.chat/core-typings';
 import type { ValidateFunction } from 'ajv';
-import type { Request } from 'express';
+import type { Request, Response } from 'express';
 
 import { ITwoFactorOptions } from '../../2fa/server/code';
 
@@ -73,11 +73,13 @@ type Options = (
 
 type PartialThis = {
 	readonly request: Request & { query: Record<string, string> };
+	readonly response: Response;
 };
 
 type ActionThis<TMethod extends Method, TPathPattern extends PathPattern, TOptions> = {
 	readonly requestIp: string;
 	urlParams: UrlParams<TPathPattern>;
+	readonly response: Response;
 	// TODO make it unsafe
 	readonly queryParams: TMethod extends 'GET'
 		? TOptions extends { validateParams: ValidateFunction<infer T> }
@@ -91,6 +93,9 @@ type ActionThis<TMethod extends Method, TPathPattern extends PathPattern, TOptio
 		? T
 		: Partial<OperationParams<TMethod, TPathPattern>>;
 	readonly request: Request;
+
+	readonly queryOperations: TOptions extends { queryOperations: infer T } ? T : never;
+
 	/* @deprecated */
 	requestParams(): OperationParams<TMethod, TPathPattern>;
 	getLoggedInUser(): TOptions extends { authRequired: true } ? IUser : IUser | undefined;
@@ -106,6 +111,8 @@ type ActionThis<TMethod extends Method, TPathPattern extends PathPattern, TOptio
 	/* @deprecated */
 	getUserFromParams(): IUser;
 	/* @deprecated */
+	isUserFromParams(): boolean;
+	/* @deprecated */
 	getUserInfo(me: IUser): TOptions extends { authRequired: true }
 		? IUser & {
 				email?: string;
@@ -153,6 +160,8 @@ type Operations<TPathPattern extends PathPattern, TOptions extends Options = {}>
 declare class APIClass<TBasePath extends string = '/'> {
 	fieldSeparator: string;
 
+	updateRateLimiterDictionaryForRoute(route: string, rateLimiterDictionary: number): void;
+
 	limitedUserFieldsToExclude(fields: { [x: string]: unknown }, limitedUserFieldsToExclude: unknown): { [x: string]: unknown };
 
 	limitedUserFieldsToExcludeIfIsPrivilegedUser(

diff --git a/apps/meteor/app/api/server/lib/users.ts b/apps/meteor/app/api/server/lib/users.ts
@@ -16,7 +16,7 @@ export async function findUsersToAutocomplete({
 		term: string;
 	};
 }): Promise<{
-	items: IUser[];
+	items: Required<Pick<IUser, '_id' | 'name' | 'username' | 'nickname' | 'status' | 'avatarETag'>>[];
 }> {
 	if (!(await hasPermissionAsync(uid, 'view-outside-room'))) {
 		return { items: [] };
@@ -69,16 +69,7 @@ export function getInclusiveFields(query: { [k: string]: 1 }): {} {
  * get the default fields if **fields** are empty (`{}`) or `undefined`/`null`
  * @param {Object|null|undefined} fields the fields from parsed jsonQuery
  */
-export function getNonEmptyFields(fields: {}): {
-	name: number;
-	username: number;
-	emails: number;
-	roles: number;
-	status: number;
-	active: number;
-	avatarETag: number;
-	lastLogin: number;
-} {
+export function getNonEmptyFields(fields: { [k: string]: 1 | 0 }): { [k: string]: 1 } {
 	const defaultFields = {
 		name: 1,
 		username: 1,
@@ -88,7 +79,7 @@ export function getNonEmptyFields(fields: {}): {
 		active: 1,
 		avatarETag: 1,
 		lastLogin: 1,
-	};
+	} as const;
 
 	if (!fields || Object.keys(fields).length === 0) {
 		return defaultFields;