snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/ee/server/api/engagementDashboard/channels.ts

@@ -0,0 +1,136 @@
+import type { IDirectMessageRoom, IRoom } from '@rocket.chat/core-typings';
+import {
+	ajv,
+	validateBadRequestErrorResponse,
+	validateUnauthorizedErrorResponse,
+	validateForbiddenErrorResponse,
+} from '@rocket.chat/rest-typings';
+import { check, Match } from 'meteor/check';
+
+import { API } from '../../../../server/api';
+import { getPaginationItems } from '../../../../server/api/lib/getPaginationItems';
+import { findChannelsWithNumberOfMessages } from '../../lib/engagementDashboard/channels';
+import { isDateISOString, mapDateForAPI } from '../../lib/engagementDashboard/date';
+
+declare module '@rocket.chat/rest-typings' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	interface Endpoints {
+		'/v1/engagement-dashboard/channels/list': {
+			GET: (params: { start: string; end: string; offset?: number; count?: number }) => {
+				channels: {
+					room: {
+						_id: IRoom['_id'];
+						name: IRoom['name'];
+						ts: IRoom['ts'];
+						t: IRoom['t'];
+						_updatedAt: IRoom['_updatedAt'];
+						usernames?: IDirectMessageRoom['usernames'];
+					};
+					messages: number;
+					lastWeekMessages: number;
+					diffFromLastWeek: number;
+				}[];
+				count: number;
+				offset: number;
+				total: number;
+			};
+		};
+	}
+}
+
+const channelsListResponseSchema = ajv.compile<{
+	channels: {
+		room: {
+			_id: IRoom['_id'];
+			name: IRoom['name'];
+			ts: IRoom['ts'];
+			t: IRoom['t'];
+			_updatedAt: IRoom['_updatedAt'];
+			usernames?: IDirectMessageRoom['usernames'];
+		};
+		messages: number;
+		lastWeekMessages: number;
+		diffFromLastWeek: number;
+	}[];
+	count: number;
+	offset: number;
+	total: number;
+}>({
+	type: 'object',
+	properties: {
+		channels: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					room: {
+						type: 'object',
+						properties: {
+							_id: { type: 'string' },
+							name: { type: 'string' },
+							ts: { type: 'string', format: 'date-time' },
+							t: { type: 'string' },
+							_updatedAt: { type: 'string', format: 'date-time' },
+							usernames: { type: 'array', items: { type: 'string' } },
+						},
+						required: ['_id'],
+						additionalProperties: false,
+					},
+					messages: { type: 'number' },
+					lastWeekMessages: { type: 'number' },
+					diffFromLastWeek: { type: 'number' },
+				},
+				required: ['room', 'messages', 'lastWeekMessages', 'diffFromLastWeek'],
+				additionalProperties: false,
+			},
+		},
+		count: { type: 'number' },
+		offset: { type: 'number' },
+		total: { type: 'number' },
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['channels', 'count', 'offset', 'total', 'success'],
+	additionalProperties: false,
+});
+
+API.v1.get(
+	'engagement-dashboard/channels/list',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: channelsListResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+				end: Match.Where(isDateISOString),
+				offset: Match.Maybe(String),
+				count: Match.Maybe(String),
+			}),
+		);
+
+		const { start, end } = this.queryParams;
+		const { offset, count } = await getPaginationItems(this.queryParams);
+
+		const { channels, total } = await findChannelsWithNumberOfMessages({
+			start: mapDateForAPI(start),
+			end: mapDateForAPI(end),
+			options: { offset, count },
+		});
+
+		return API.v1.success({
+			channels,
+			total,
+			offset,
+			count: channels.length,
+		});
+	},
+);

apps/meteor/ee/server/api/engagementDashboard/index.ts

@@ -0,0 +1,3 @@
+import './messages';
+import './channels';
+import './users';

apps/meteor/ee/server/api/engagementDashboard/messages.ts

@@ -0,0 +1,234 @@
+import type { IDirectMessageRoom, IRoom } from '@rocket.chat/core-typings';
+import {
+	ajv,
+	validateBadRequestErrorResponse,
+	validateUnauthorizedErrorResponse,
+	validateForbiddenErrorResponse,
+} from '@rocket.chat/rest-typings';
+import { check, Match } from 'meteor/check';
+
+import { API } from '../../../../server/api';
+import { isDateISOString, transformDatesForAPI } from '../../lib/engagementDashboard/date';
+import {
+	findWeeklyMessagesSentData,
+	findMessagesSentOrigin,
+	findTopFivePopularChannelsByMessageSentQuantity,
+} from '../../lib/engagementDashboard/messages';
+
+const weeklyDataResponseSchema = ajv.compile<{
+	days: { day: Date; messages: number }[];
+	period: { count: number; variation: number };
+	yesterday: { count: number; variation: number };
+}>({
+	type: 'object',
+	properties: {
+		days: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					day: { type: 'string', format: 'date-time' },
+					messages: { type: 'number' },
+				},
+				required: ['day', 'messages'],
+				additionalProperties: false,
+			},
+		},
+		period: {
+			type: 'object',
+			properties: {
+				count: { type: 'number' },
+				variation: { type: 'number' },
+			},
+			required: ['count', 'variation'],
+			additionalProperties: false,
+		},
+		yesterday: {
+			type: 'object',
+			properties: {
+				count: { type: 'number' },
+				variation: { type: 'number' },
+			},
+			required: ['count', 'variation'],
+			additionalProperties: false,
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['days', 'period', 'yesterday', 'success'],
+	additionalProperties: false,
+});
+
+const messagesOriginResponseSchema = ajv.compile<{ origins: { t: IRoom['t']; messages: number }[] }>({
+	type: 'object',
+	properties: {
+		origins: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					t: { type: 'string' },
+					messages: { type: 'number' },
+				},
+				required: ['t', 'messages'],
+				additionalProperties: false,
+			},
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['origins', 'success'],
+	additionalProperties: false,
+});
+
+const topFivePopularChannelsResponseSchema = ajv.compile<{
+	channels: {
+		t: IRoom['t'];
+		messages: number;
+		name: IRoom['name'];
+		usernames?: IDirectMessageRoom['usernames'];
+	}[];
+}>({
+	type: 'object',
+	properties: {
+		channels: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					t: { type: 'string' },
+					messages: { type: 'number' },
+					name: { type: 'string' },
+					usernames: { type: 'array', items: { type: 'string' } },
+				},
+				required: ['t', 'messages'],
+				additionalProperties: false,
+			},
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['channels', 'success'],
+	additionalProperties: false,
+});
+
+declare module '@rocket.chat/rest-typings' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	interface Endpoints {
+		'/v1/engagement-dashboard/messages/origin': {
+			GET: (params: { start: string; end: string }) => {
+				origins: {
+					t: IRoom['t'];
+					messages: number;
+				}[];
+			};
+		};
+		'/v1/engagement-dashboard/messages/top-five-popular-channels': {
+			GET: (params: { start: string; end: string }) => {
+				channels: {
+					t: IRoom['t'];
+					messages: number;
+					name: IRoom['name'];
+					usernames?: IDirectMessageRoom['usernames'];
+				}[];
+			};
+		};
+		'/v1/engagement-dashboard/messages/messages-sent': {
+			GET: (params: { start: string; end: string }) => {
+				days: { day: Date; messages: number }[];
+				period: {
+					count: number;
+					variation: number;
+				};
+				yesterday: {
+					count: number;
+					variation: number;
+				};
+			};
+		};
+	}
+}
+
+API.v1.get(
+	'engagement-dashboard/messages/messages-sent',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: weeklyDataResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+				end: Match.Where(isDateISOString),
+			}),
+		);
+
+		const { start, end } = this.queryParams;
+
+		const data = await findWeeklyMessagesSentData(transformDatesForAPI(start, end));
+		return API.v1.success(data);
+	},
+);
+
+API.v1.get(
+	'engagement-dashboard/messages/origin',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: messagesOriginResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+				end: Match.Where(isDateISOString),
+			}),
+		);
+
+		const { start, end } = this.queryParams;
+
+		const data = await findMessagesSentOrigin(transformDatesForAPI(start, end));
+		return API.v1.success(data);
+	},
+);
+
+API.v1.get(
+	'engagement-dashboard/messages/top-five-popular-channels',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: topFivePopularChannelsResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+				end: Match.Where(isDateISOString),
+			}),
+		);
+
+		const { start, end } = this.queryParams;
+
+		const data = await findTopFivePopularChannelsByMessageSentQuantity(transformDatesForAPI(start, end));
+		return API.v1.success(data);
+	},
+);

apps/meteor/ee/server/api/engagementDashboard/users.ts

@@ -0,0 +1,361 @@
+import type { IUser } from '@rocket.chat/core-typings';
+import {
+	ajv,
+	validateBadRequestErrorResponse,
+	validateUnauthorizedErrorResponse,
+	validateForbiddenErrorResponse,
+} from '@rocket.chat/rest-typings';
+import { check, Match } from 'meteor/check';
+
+import { API } from '../../../../server/api';
+import { isDateISOString, transformDatesForAPI } from '../../lib/engagementDashboard/date';
+import {
+	findWeeklyUsersRegisteredData,
+	findActiveUsersMonthlyData,
+	findBusiestsChatsInADayByHours,
+	findBusiestsChatsWithinAWeek,
+	findUserSessionsByHourWithinAWeek,
+} from '../../lib/engagementDashboard/users';
+
+const newUsersResponseSchema = ajv.compile<{
+	days: { day: Date; users: number }[];
+	period: { count: number; variation: number };
+	yesterday: { count: number; variation: number };
+}>({
+	type: 'object',
+	properties: {
+		days: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					day: { type: 'string', format: 'date-time' },
+					users: { type: 'number' },
+				},
+				required: ['day', 'users'],
+				additionalProperties: false,
+			},
+		},
+		period: {
+			type: 'object',
+			properties: {
+				count: { type: 'number' },
+				variation: { type: 'number' },
+			},
+			required: ['count', 'variation'],
+			additionalProperties: false,
+		},
+		yesterday: {
+			type: 'object',
+			properties: {
+				count: { type: 'number' },
+				variation: { type: 'number' },
+			},
+			required: ['count', 'variation'],
+			additionalProperties: false,
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['days', 'period', 'yesterday', 'success'],
+	additionalProperties: false,
+});
+
+const activeUsersResponseSchema = ajv.compile<{
+	month: { day: number; month: number; year: number; usersList: IUser['_id'][]; users: number }[];
+}>({
+	type: 'object',
+	properties: {
+		month: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					day: { type: 'number' },
+					month: { type: 'number' },
+					year: { type: 'number' },
+					usersList: { type: 'array', items: { type: 'string' } },
+					users: { type: 'number' },
+				},
+				required: ['day', 'month', 'year', 'usersList', 'users'],
+				additionalProperties: false,
+			},
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['month', 'success'],
+	additionalProperties: false,
+});
+
+const hourlyDataResponseSchema = ajv.compile<{ hours: { hour: number; users: number }[] }>({
+	type: 'object',
+	properties: {
+		hours: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					hour: { type: 'number' },
+					users: { type: 'number' },
+				},
+				required: ['hour', 'users'],
+				additionalProperties: false,
+			},
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['hours', 'success'],
+	additionalProperties: false,
+});
+
+const weeklyChatBusierResponseSchema = ajv.compile<{
+	month: { day: number; month: number; year: number; users: number }[];
+}>({
+	type: 'object',
+	properties: {
+		month: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					day: { type: 'number' },
+					month: { type: 'number' },
+					year: { type: 'number' },
+					users: { type: 'number' },
+				},
+				required: ['day', 'month', 'year', 'users'],
+				additionalProperties: false,
+			},
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['month', 'success'],
+	additionalProperties: false,
+});
+
+const userSessionsByHourResponseSchema = ajv.compile<{
+	week: { hour: number; day: number; month: number; year: number; users: number }[];
+}>({
+	type: 'object',
+	properties: {
+		week: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					hour: { type: 'number' },
+					day: { type: 'number' },
+					month: { type: 'number' },
+					year: { type: 'number' },
+					users: { type: 'number' },
+				},
+				required: ['hour', 'day', 'month', 'year', 'users'],
+				additionalProperties: false,
+			},
+		},
+		success: { type: 'boolean', enum: [true] },
+	},
+	required: ['week', 'success'],
+	additionalProperties: false,
+});
+
+declare module '@rocket.chat/rest-typings' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	interface Endpoints {
+		'/v1/engagement-dashboard/users/active-users': {
+			GET: (params: { start: string; end: string }) => {
+				month: {
+					day: number;
+					month: number;
+					year: number;
+					usersList: IUser['_id'][];
+					users: number;
+				}[];
+			};
+		};
+		'/v1/engagement-dashboard/users/chat-busier/weekly-data': {
+			GET: (params: { start: string }) => {
+				month: {
+					users: number;
+					day: number;
+					month: number;
+					year: number;
+				}[];
+			};
+		};
+		'/v1/engagement-dashboard/users/chat-busier/hourly-data': {
+			GET: (params: { start: string }) => {
+				hours: {
+					users: number;
+					hour: number;
+				}[];
+			};
+		};
+		'/v1/engagement-dashboard/users/users-by-time-of-the-day-in-a-week': {
+			GET: (params: { start: string; end: string }) => {
+				week: {
+					users: number;
+					hour: number;
+					day: number;
+					month: number;
+					year: number;
+				}[];
+			};
+		};
+		'/v1/engagement-dashboard/users/new-users': {
+			GET: (params: { start: string; end: string }) => {
+				days: { day: Date; users: number }[];
+				period: {
+					count: number;
+					variation: number;
+				};
+				yesterday: {
+					count: number;
+					variation: number;
+				};
+			};
+		};
+	}
+}
+
+API.v1.get(
+	'engagement-dashboard/users/new-users',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: newUsersResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+				end: Match.Where(isDateISOString),
+			}),
+		);
+
+		const { start, end } = this.queryParams;
+
+		const data = await findWeeklyUsersRegisteredData(transformDatesForAPI(start, end));
+		return API.v1.success(data);
+	},
+);
+
+API.v1.get(
+	'engagement-dashboard/users/active-users',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: activeUsersResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+				end: Match.Where(isDateISOString),
+			}),
+		);
+
+		const { start, end } = this.queryParams;
+
+		const data = await findActiveUsersMonthlyData(transformDatesForAPI(start, end));
+		return API.v1.success(data);
+	},
+);
+
+API.v1.get(
+	'engagement-dashboard/users/chat-busier/hourly-data',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: hourlyDataResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+			}),
+		);
+
+		const { start } = this.queryParams;
+
+		const data = await findBusiestsChatsInADayByHours(transformDatesForAPI(start));
+		return API.v1.success(data);
+	},
+);
+
+API.v1.get(
+	'engagement-dashboard/users/chat-busier/weekly-data',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: weeklyChatBusierResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+			}),
+		);
+
+		const { start } = this.queryParams;
+
+		const data = await findBusiestsChatsWithinAWeek(transformDatesForAPI(start));
+		return API.v1.success(data);
+	},
+);
+
+API.v1.get(
+	'engagement-dashboard/users/users-by-time-of-the-day-in-a-week',
+	{
+		authRequired: true,
+		permissionsRequired: ['view-engagement-dashboard'],
+		license: ['engagement-dashboard'],
+		response: {
+			200: userSessionsByHourResponseSchema,
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+		},
+	},
+	async function action() {
+		check(
+			this.queryParams,
+			Match.ObjectIncluding({
+				start: Match.Where(isDateISOString),
+				end: Match.Where(isDateISOString),
+			}),
+		);
+
+		const { start, end } = this.queryParams;
+
+		const data = await findUserSessionsByHourWithinAWeek(transformDatesForAPI(start, end));
+		return API.v1.success(data);
+	},
+);