refactor(api): migrate emoji-custom, invites and subscriptions to new… (RocketChat#39333)

Author: ggazzo

apps/meteor/app/api/server/v1/emoji-custom.ts

@@ -1,7 +1,7 @@
 import { Media } from '@rocket.chat/core-services';
 import type { IEmojiCustom } from '@rocket.chat/core-typings';
 import { EmojiCustom } from '@rocket.chat/models';
-import { ajv, isEmojiCustomList } from '@rocket.chat/rest-typings';
+import { ajv, isEmojiCustomList, validateBadRequestErrorResponse, validateUnauthorizedErrorResponse } from '@rocket.chat/rest-typings';
 import { escapeRegExp } from '@rocket.chat/string-helpers';
 import { Meteor } from 'meteor/meteor';
 
@@ -30,11 +30,43 @@ function validateDateParam(paramName: string, paramValue: string | undefined): D
 	return date;
 }
 
-API.v1.addRoute(
-	'emoji-custom.list',
-	{ authRequired: true, validateParams: isEmojiCustomList },
-	{
-		async get() {
+const emojiListResponseSchema = ajv.compile({
+	type: 'object',
+	properties: {
+		emojis: {
+			type: 'object',
+			properties: {
+				update: { type: 'array', items: { type: 'object' } },
+				remove: { type: 'array', items: { type: 'object' } },
+			},
+			required: ['update', 'remove'],
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['emojis', 'success'],
+	additionalProperties: false,
+});
+
+const emojiDeleteBodySchema = ajv.compile({
+	type: 'object',
+	properties: { emojiId: { type: 'string' } },
+	required: ['emojiId'],
+	additionalProperties: false,
+});
+
+const emojiCustomCreateEndpoints = API.v1
+	.get(
+		'emoji-custom.list',
+		{
+			authRequired: true,
+			query: isEmojiCustomList,
+			response: {
+				200: emojiListResponseSchema,
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+			},
+		},
+		async function action() {
 			const { query } = await this.parseJsonQuery();
 			const { updatedSince, _updatedAt, _id } = this.queryParams;
 
@@ -71,14 +103,28 @@ API.v1.addRoute(
 				},
 			});
 		},
-	},
-);
-
-API.v1.addRoute(
-	'emoji-custom.all',
-	{ authRequired: true },
-	{
-		async get() {
+	)
+	.get(
+		'emoji-custom.all',
+		{
+			authRequired: true,
+			response: {
+				200: ajv.compile({
+					type: 'object',
+					properties: {
+						emojis: { type: 'array', items: { type: 'object' } },
+						total: { type: 'number' },
+						count: { type: 'number' },
+						offset: { type: 'number' },
+						success: { type: 'boolean', enum: [true] },
+					},
+					required: ['emojis', 'total', 'count', 'offset', 'success'],
+					additionalProperties: false,
+				}),
+				401: validateUnauthorizedErrorResponse,
+			},
+		},
+		async function action() {
 			const { offset, count } = await getPaginationItems(this.queryParams);
 			const { sort, query } = await this.parseJsonQuery();
 			const { name } = this.queryParams;
@@ -101,84 +147,92 @@ API.v1.addRoute(
 				}),
 			);
 		},
-	},
-);
-
-const emojiCustomCreateEndpoints = API.v1.post(
-	'emoji-custom.create',
-	{
-		authRequired: true,
-		response: {
-			400: ajv.compile({
-				type: 'object',
-				properties: {
-					success: { type: 'boolean', enum: [false] },
-					stack: { type: 'string' },
-					error: { type: 'string' },
-					errorType: { type: 'string' },
-					details: { type: 'string' },
-				},
-				required: ['success'],
-				additionalProperties: false,
-			}),
-			200: ajv.compile<void>({
-				type: 'object',
-				properties: {
-					success: {
-						type: 'boolean',
-						enum: [true],
+	)
+	.post(
+		'emoji-custom.create',
+		{
+			authRequired: true,
+			response: {
+				400: ajv.compile({
+					type: 'object',
+					properties: {
+						success: { type: 'boolean', enum: [false] },
+						stack: { type: 'string' },
+						error: { type: 'string' },
+						errorType: { type: 'string' },
+						details: { type: 'string' },
 					},
-				},
-				required: ['success'],
-				additionalProperties: false,
-			}),
-		},
-	},
-	async function action() {
-		const emoji = await getUploadFormData(
-			{
-				request: this.request,
-			},
-			{
-				field: 'emoji',
-				sizeLimit: settings.get('FileUpload_MaxFileSize'),
+					required: ['success'],
+					additionalProperties: false,
+				}),
+				200: ajv.compile<void>({
+					type: 'object',
+					properties: {
+						success: {
+							type: 'boolean',
+							enum: [true],
+						},
+					},
+					required: ['success'],
+					additionalProperties: false,
+				}),
 			},
-		);
-
-		const { fields, fileBuffer, mimetype } = emoji;
+		},
+		async function action() {
+			const emoji = await getUploadFormData(
+				{
+					request: this.request,
+				},
+				{
+					field: 'emoji',
+					sizeLimit: settings.get('FileUpload_MaxFileSize'),
+				},
+			);
 
-		const isUploadable = await Media.isImage(fileBuffer);
-		if (!isUploadable) {
-			throw new Meteor.Error('emoji-is-not-image', "Emoji file provided cannot be uploaded since it's not an image");
-		}
+			const { fields, fileBuffer, mimetype } = emoji;
 
-		const [, extension] = mimetype.split('/');
-		fields.extension = extension;
+			const isUploadable = await Media.isImage(fileBuffer);
+			if (!isUploadable) {
+				throw new Meteor.Error('emoji-is-not-image', "Emoji file provided cannot be uploaded since it's not an image");
+			}
 
-		try {
-			const emojiData = await insertOrUpdateEmoji(this.userId, {
-				...fields,
-				newFile: true,
-				aliases: fields.aliases || '',
-				name: fields.name,
-				extension: fields.extension,
-			});
+			const [, extension] = mimetype.split('/');
+			fields.extension = extension;
 
-			await uploadEmojiCustomWithBuffer(this.userId, fileBuffer, mimetype, emojiData);
-		} catch (err) {
-			SystemLogger.error({ err });
-			return API.v1.failure();
-		}
+			try {
+				const emojiData = await insertOrUpdateEmoji(this.userId, {
+					...fields,
+					newFile: true,
+					aliases: fields.aliases || '',
+					name: fields.name,
+					extension: fields.extension,
+				});
 
-		return API.v1.success();
-	},
-);
+				await uploadEmojiCustomWithBuffer(this.userId, fileBuffer, mimetype, emojiData);
+			} catch (err) {
+				SystemLogger.error({ err });
+				return API.v1.failure();
+			}
 
-API.v1.addRoute(
-	'emoji-custom.update',
-	{ authRequired: true },
-	{
-		async post() {
+			return API.v1.success();
+		},
+	)
+	.post(
+		'emoji-custom.update',
+		{
+			authRequired: true,
+			response: {
+				200: ajv.compile({
+					type: 'object',
+					properties: { success: { type: 'boolean', enum: [true] } },
+					required: ['success'],
+					additionalProperties: false,
+				}),
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+			},
+		},
+		async function action() {
 			const emoji = await getUploadFormData(
 				{
 					request: this.request,
@@ -229,14 +283,24 @@ API.v1.addRoute(
 			}
 			return API.v1.success();
 		},
-	},
-);
-
-API.v1.addRoute(
-	'emoji-custom.delete',
-	{ authRequired: true },
-	{
-		async post() {
+	)
+	.post(
+		'emoji-custom.delete',
+		{
+			authRequired: true,
+			body: emojiDeleteBodySchema,
+			response: {
+				200: ajv.compile({
+					type: 'object',
+					properties: { success: { type: 'boolean', enum: [true] } },
+					required: ['success'],
+					additionalProperties: false,
+				}),
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+			},
+		},
+		async function action() {
 			const { emojiId } = this.bodyParams;
 			if (!emojiId) {
 				return API.v1.failure('The "emojiId" params is required!');
@@ -246,8 +310,7 @@ API.v1.addRoute(
 
 			return API.v1.success();
 		},
-	},
-);
+	);
 
 type EmojiCustomCreateEndpoints = ExtractRoutesFromAPI<typeof emojiCustomCreateEndpoints>;