Chore: Omnichannel endpoints to ts

apps/meteor/app/api/server/api.d.ts

@@ -139,6 +139,7 @@ type ActionThis<TMethod extends Method, TPathPattern extends PathPattern, TOptio
 		me: IUser,
 	): TOptions extends { authRequired: true } ? UserInfo : TOptions extends { authOrAnonRequired: true } ? UserInfo | undefined : undefined;
 	composeRoomWithLastMessage(room: IRoom, userId: string): IRoom;
+	isWidget(): boolean;
 } & (TOptions extends { authRequired: true }
 	? {
 			readonly user: IUser;

apps/meteor/app/livechat/imports/server/rest/agent.js → apps/meteor/app/livechat/imports/server/rest/agent.ts

@@ -1,22 +1,14 @@
-import { Match, check } from 'meteor/check';
+import { isGETLivechatAgentsAgentIdDepartmentsParams } from '@rocket.chat/rest-typings';
 
 import { API } from '../../../../api/server';
 import { findAgentDepartments } from '../../../server/api/lib/agents';
 
 API.v1.addRoute(
 	'livechat/agents/:agentId/departments',
-	{ authRequired: true, permissionsRequired: ['view-l-room'] },
+	{ authRequired: true, permissionsRequired: ['view-l-room'], validateParams: isGETLivechatAgentsAgentIdDepartmentsParams },
 	{
 		async get() {
-			check(this.urlParams, {
-				agentId: String,
-			});
-			check(this.queryParams, {
-				enabledDepartmentsOnly: Match.Maybe(String),
-			});
-
 			const departments = await findAgentDepartments({
-				userId: this.userId,
 				enabledDepartmentsOnly: this.queryParams.enabledDepartmentsOnly && this.queryParams.enabledDepartmentsOnly === 'true',
 				agentId: this.urlParams.agentId,
 			});

apps/meteor/app/livechat/imports/server/rest/businessHours.js → apps/meteor/app/livechat/imports/server/rest/businessHours.ts

@@ -1,9 +1,11 @@
+import { isGETBusinessHourParams } from '@rocket.chat/rest-typings';
+
 import { API } from '../../../../api/server';
 import { findLivechatBusinessHour } from '../../../server/api/lib/businessHours';
 
 API.v1.addRoute(
 	'livechat/business-hour',
-	{ authRequired: true, permissionsRequired: ['view-livechat-business-hours'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-business-hours'], validateParams: isGETBusinessHourParams },
 	{
 		async get() {
 			const { _id, type } = this.queryParams;

apps/meteor/app/livechat/imports/server/rest/dashboards.js → apps/meteor/app/livechat/imports/server/rest/dashboards.ts

@@ -1,4 +1,4 @@
-import { Match, check } from 'meteor/check';
+import { isGETDashboardTotalizerParams, isGETDashboardsAgentStatusParams } from '@rocket.chat/rest-typings';
 
 import { API } from '../../../../api/server';
 import {
@@ -16,117 +16,109 @@ import { Users } from '../../../../models/server';
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/conversation-totalizers',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{
+		authRequired: true,
+		permissionsRequired: ['view-livechat-manager'],
+		validateParams: isGETDashboardTotalizerParams,
+	},
 	{
 		async get() {
-			let { start, end } = this.requestParams();
+			const { start, end } = this.requestParams();
 			const { departmentId } = this.requestParams();
 
-			check(start, String);
-			check(end, String);
-			check(departmentId, Match.Maybe(String));
-
 			if (isNaN(Date.parse(start))) {
 				return API.v1.failure('The "start" query parameter must be a valid date.');
 			}
-			start = new Date(start);
+			const startDate = new Date(start);
 
 			if (isNaN(Date.parse(end))) {
 				return API.v1.failure('The "end" query parameter must be a valid date.');
 			}
-			end = new Date(end);
+			const endDate = new Date(end);
 
 			const user = Users.findOneById(this.userId, { fields: { utcOffset: 1, language: 1 } });
 
-			const totalizers = getConversationsMetrics({ start, end, departmentId, user });
+			// @ts-expect-error TODO: fix this
+			const totalizers = getConversationsMetrics({ start: startDate, end: endDate, departmentId, user });
 			return API.v1.success(totalizers);
 		},
 	},
 );
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/agents-productivity-totalizers',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-manager'], validateParams: isGETDashboardTotalizerParams },
 	{
 		async get() {
-			let { start, end } = this.requestParams();
+			const { start, end } = this.requestParams();
 			const { departmentId } = this.requestParams();
 
-			check(start, String);
-			check(end, String);
-			check(departmentId, Match.Maybe(String));
-
 			if (isNaN(Date.parse(start))) {
 				return API.v1.failure('The "start" query parameter must be a valid date.');
 			}
-			start = new Date(start);
+			const startDate = new Date(start);
 
 			if (isNaN(Date.parse(end))) {
 				return API.v1.failure('The "end" query parameter must be a valid date.');
 			}
-			end = new Date(end);
+			const endDate = new Date(end);
 
 			const user = Users.findOneById(this.userId, { fields: { utcOffset: 1, language: 1 } });
 
-			const totalizers = getAgentsProductivityMetrics({ start, end, departmentId, user });
+			// @ts-expect-error TODO: fix this
+			const totalizers = getAgentsProductivityMetrics({ start: startDate, end: endDate, departmentId, user });
 			return API.v1.success(totalizers);
 		},
 	},
 );
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/chats-totalizers',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-manager'], validateParams: isGETDashboardTotalizerParams },
 	{
 		async get() {
-			let { start, end } = this.requestParams();
+			const { start, end } = this.requestParams();
 			const { departmentId } = this.requestParams();
 
-			check(start, String);
-			check(end, String);
-			check(departmentId, Match.Maybe(String));
-
 			if (isNaN(Date.parse(start))) {
 				return API.v1.failure('The "start" query parameter must be a valid date.');
 			}
-			start = new Date(start);
+			const startDate = new Date(start);
 
 			if (isNaN(Date.parse(end))) {
 				return API.v1.failure('The "end" query parameter must be a valid date.');
 			}
-			end = new Date(end);
+			const endDate = new Date(end);
 
-			const totalizers = getChatsMetrics({ start, end, departmentId });
+			// @ts-expect-error TODO: fix this
+			const totalizers = getChatsMetrics({ start: startDate, end: endDate, departmentId });
 			return API.v1.success(totalizers);
 		},
 	},
 );
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/productivity-totalizers',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-manager'], validateParams: isGETDashboardTotalizerParams },
 	{
 		async get() {
-			let { start, end } = this.requestParams();
+			const { start, end } = this.requestParams();
 			const { departmentId } = this.requestParams();
 
-			check(start, String);
-			check(end, String);
-			check(departmentId, Match.Maybe(String));
-
 			if (isNaN(Date.parse(start))) {
 				return API.v1.failure('The "start" query parameter must be a valid date.');
 			}
-			start = new Date(start);
+			const startDate = new Date(start);
 
 			if (isNaN(Date.parse(end))) {
 				return API.v1.failure('The "end" query parameter must be a valid date.');
 			}
-			end = new Date(end);
+			const endDate = new Date(end);
 
 			const user = Users.findOneById(this.userId, { fields: { utcOffset: 1, language: 1 } });
 
-			const totalizers = getProductivityMetrics({ start, end, departmentId, user });
+			// @ts-expect-error TODO: fix this
+			const totalizers = getProductivityMetrics({ start: startDate, end: endDate, departmentId, user });
 
 			return API.v1.success(totalizers);
 		},
@@ -135,26 +127,24 @@ API.v1.addRoute(
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/charts/chats',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-manager'], validateParams: isGETDashboardTotalizerParams },
 	{
 		async get() {
-			let { start, end } = this.requestParams();
+			const { start, end } = this.requestParams();
 			const { departmentId } = this.requestParams();
 
-			check(start, String);
-			check(end, String);
-			check(departmentId, Match.Maybe(String));
-
 			if (isNaN(Date.parse(start))) {
 				return API.v1.failure('The "start" query parameter must be a valid date.');
 			}
-			start = new Date(start);
+			const startDate = new Date(start);
 
 			if (isNaN(Date.parse(end))) {
 				return API.v1.failure('The "end" query parameter must be a valid date.');
 			}
-			end = new Date(end);
-			const result = findAllChatsStatus({ start, end, departmentId });
+			const endDate = new Date(end);
+
+			// @ts-expect-error TODO: fix this
+			const result = findAllChatsStatus({ start: startDate, end: endDate, departmentId });
 
 			return API.v1.success(result);
 		},
@@ -163,26 +153,25 @@ API.v1.addRoute(
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/charts/chats-per-agent',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-manager'], validateParams: isGETDashboardTotalizerParams },
 	{
 		async get() {
-			let { start, end } = this.requestParams();
+			const { start, end } = this.requestParams();
 			const { departmentId } = this.requestParams();
 
-			check(start, String);
-			check(end, String);
-			check(departmentId, Match.Maybe(String));
-
 			if (isNaN(Date.parse(start))) {
 				return API.v1.failure('The "start" query parameter must be a valid date.');
 			}
-			start = new Date(start);
+			const startDate = new Date(start);
 
 			if (isNaN(Date.parse(end))) {
 				return API.v1.failure('The "end" query parameter must be a valid date.');
 			}
-			end = new Date(end);
-			const result = findAllChatMetricsByAgent({ start, end, departmentId });
+			const endDate = new Date(end);
+			// @ts-expect-error TODO: fix this
+			const result = findAllChatMetricsByAgent({ start: startDate, end: endDate, departmentId }) as {
+				[k: string]: { open: number; closed: number; onhold: number };
+			};
 
 			return API.v1.success(result);
 		},
@@ -191,12 +180,12 @@ API.v1.addRoute(
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/charts/agents-status',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-manager'], validateParams: isGETDashboardsAgentStatusParams },
 	{
 		async get() {
 			const { departmentId } = this.requestParams();
-			check(departmentId, Match.Maybe(String));
 
+			// @ts-expect-error TODO: fix this
 			const result = findAllAgentsStatus({ departmentId });
 
 			return API.v1.success(result);
@@ -206,26 +195,26 @@ API.v1.addRoute(
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/charts/chats-per-department',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-manager'], validateParams: isGETDashboardTotalizerParams },
 	{
 		async get() {
-			let { start, end } = this.requestParams();
+			const { start, end } = this.requestParams();
 			const { departmentId } = this.requestParams();
 
-			check(start, String);
-			check(end, String);
-			check(departmentId, Match.Maybe(String));
-
 			if (isNaN(Date.parse(start))) {
 				return API.v1.failure('The "start" query parameter must be a valid date.');
 			}
-			start = new Date(start);
+			const startDate = new Date(start);
 
 			if (isNaN(Date.parse(end))) {
 				return API.v1.failure('The "end" query parameter must be a valid date.');
 			}
-			end = new Date(end);
-			const result = findAllChatMetricsByDepartment({ start, end, departmentId });
+			const endDate = new Date(end);
+
+			// @ts-expect-error TODO: fix this
+			const result = findAllChatMetricsByDepartment({ start: startDate, end: endDate, departmentId }) as {
+				[k: string]: { open: number; closed: number };
+			};
 
 			return API.v1.success(result);
 		},
@@ -234,26 +223,24 @@ API.v1.addRoute(
 
 API.v1.addRoute(
 	'livechat/analytics/dashboards/charts/timings',
-	{ authRequired: true, permissionsRequired: ['view-livechat-manager'] },
+	{ authRequired: true, permissionsRequired: ['view-livechat-manager'], validateParams: isGETDashboardTotalizerParams },
 	{
 		async get() {
-			let { start, end } = this.requestParams();
+			const { start, end } = this.requestParams();
 			const { departmentId } = this.requestParams();
 
-			check(start, String);
-			check(end, String);
-			check(departmentId, Match.Maybe(String));
-
 			if (isNaN(Date.parse(start))) {
 				return API.v1.failure('The "start" query parameter must be a valid date.');
 			}
-			start = new Date(start);
+			const startDate = new Date(start);
 
 			if (isNaN(Date.parse(end))) {
 				return API.v1.failure('The "end" query parameter must be a valid date.');
 			}
-			end = new Date(end);
-			const result = findAllResponseTimeMetrics({ start, end, departmentId });
+			const endDate = new Date(end);
+
+			// @ts-expect-error TODO: fix this
+			const result = findAllResponseTimeMetrics({ start: startDate, end: endDate, departmentId });
 
 			return API.v1.success(result);
 		},