Chore: add Ajv JSON Schema to api/v1 (#25601)

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

@@ -2,7 +2,14 @@
  * Docs: https://github.com/RocketChat/developer-docs/blob/master/reference/api/rest-api/endpoints/team-collaboration-endpoints/im-endpoints
  */
 import type { IMessage, IRoom, ISetting, ISubscription, IUpload, IUser } from '@rocket.chat/core-typings';
-import { isDmDeleteProps, isDmFileProps, isDmMemberProps, isDmMessagesProps, isDmCreateProps } from '@rocket.chat/rest-typings';
+import {
+	isDmDeleteProps,
+	isDmFileProps,
+	isDmMemberProps,
+	isDmMessagesProps,
+	isDmCreateProps,
+	isDmHistoryProps,
+} from '@rocket.chat/rest-typings';
 import { Meteor } from 'meteor/meteor';
 import { Match, check } from 'meteor/check';
 
@@ -240,7 +247,7 @@ API.v1.addRoute(
 
 API.v1.addRoute(
 	['dm.history', 'im.history'],
-	{ authRequired: true },
+	{ authRequired: true, validateParams: isDmHistoryProps },
 	{
 		async get() {
 			const { offset = 0, count = 20 } = this.getPaginationItems();

apps/meteor/app/livechat/imports/server/rest/departments.ts

@@ -1,3 +1,4 @@
+import { isLivechatDepartmentProps } from '@rocket.chat/rest-typings';
 import { Match, check } from 'meteor/check';
 
 import { API } from '../../../../api/server';
@@ -14,9 +15,9 @@ import {
 
 API.v1.addRoute(
 	'livechat/department',
-	{ authRequired: true },
+	{ authRequired: true, validateParams: isLivechatDepartmentProps },
 	{
-		get() {
+		async get() {
 			const { offset, count } = this.getPaginationItems();
 			const { sort } = this.parseJsonQuery();
 
@@ -26,7 +27,7 @@ API.v1.addRoute(
 				findDepartments({
 					userId: this.userId,
 					text,
-					enabled,
+					enabled: enabled === 'true',
 					onlyMyDepartments: onlyMyDepartments === 'true',
 					excludeDepartmentId,
 					pagination: {

apps/meteor/client/components/Omnichannel/hooks/useDepartmentsList.ts

@@ -27,9 +27,8 @@ export const useDepartmentsList = (
 	const t = useTranslation();
 	const [itemsList, setItemsList] = useState(() => new RecordList<ILivechatDepartmentRecord>());
 	const reload = useCallback(() => setItemsList(new RecordList<ILivechatDepartmentRecord>()), []);
-	const endpoint = 'livechat/department';
 
-	const getDepartments = useEndpoint('GET', endpoint);
+	const getDepartments = useEndpoint('GET', 'livechat/department');
 
 	useComponentDidUpdate(() => {
 		options && reload();
@@ -44,7 +43,7 @@ export const useDepartmentsList = (
 				count: end + start,
 				sort: `{ "name": 1 }`,
 				excludeDepartmentId: options.excludeDepartmentId,
-				enabled: options.enabled,
+				enabled: options.enabled ? 'true' : 'false',
 			});
 
 			const items = departments

apps/meteor/client/views/omnichannel/directory/calls/CallTable.tsx

@@ -22,7 +22,7 @@ const useQuery = (
 	userIdLoggedIn: string | null,
 ): {
 	sort: string;
-	open: boolean;
+	open: 'false';
 	roomName: string;
 	agents: string[];
 	count?: number;
@@ -31,7 +31,7 @@ const useQuery = (
 	useMemo(
 		() => ({
 			sort: JSON.stringify({ [column]: direction === 'asc' ? 1 : -1 }),
-			open: false,
+			open: 'false',
 			roomName: text || '',
 			agents: userIdLoggedIn ? [userIdLoggedIn] : [],
 			...(itemsPerPage && { count: itemsPerPage }),

apps/meteor/client/views/omnichannel/queueList/hooks/useQuery.ts

@@ -12,7 +12,7 @@ type useQueryType = (
 	debouncedSort: [string, 'asc' | 'desc'],
 ) => {
 	agentId?: ILivechatAgent['_id'];
-	includeOfflineAgents?: boolean;
+	includeOfflineAgents?: 'true' | 'false';
 	departmentId?: ILivechatAgent['_id'];
 	offset: number;
 	count: number;
@@ -25,7 +25,7 @@ export const useQuery: useQueryType = ({ servedBy, status, departmentId, itemsPe
 	useMemo(() => {
 		const query: {
 			agentId?: string;
-			includeOflineAgents?: boolean;
+			includeOflineAgents?: 'true' | 'false';
 			departmentId?: string;
 			sort: string;
 			count: number;
@@ -39,7 +39,7 @@ export const useQuery: useQueryType = ({ servedBy, status, departmentId, itemsPe
 		};
 
 		if (status !== 'online') {
-			query.includeOflineAgents = true;
+			query.includeOflineAgents = 'true';
 		}
 		if (servedBy) {
 			query.agentId = servedBy;

apps/meteor/tests/end-to-end/api/04-direct-message.js

@@ -170,7 +170,6 @@ describe('[Direct Messages]', function () {
 			.set(credentials)
 			.query({
 				roomId: directMessage._id,
-				userId: 'rocket.cat',
 			})
 			.expect('Content-Type', 'application/json')
 			.expect(200)

packages/rest-typings/src/index.ts

@@ -157,7 +157,9 @@ export * from './v1/channels/ChannelsConvertToTeamProps';
 export * from './v1/channels/ChannelsSetReadOnlyProps';
 export * from './v1/channels/ChannelsDeleteProps';
 export * from './v1/dm';
+export * from './v1/dm/DmHistoryProps';
 export * from './v1/integrations';
+export * from './v1/omnichannel';
 export * from './v1/oauthapps';
 export * from './helpers/PaginatedRequest';
 export * from './helpers/PaginatedResult';

packages/rest-typings/src/v1/banners.ts

@@ -1,26 +1,104 @@
+import Ajv from 'ajv';
 import type { BannerPlatform, IBanner } from '@rocket.chat/core-typings';
 
+const ajv = new Ajv({
+	coerceTypes: true,
+});
+
+type BannersGetNew = {
+	platform: BannerPlatform;
+	bid: IBanner['_id'];
+};
+
+const BannersGetNewSchema = {
+	type: 'object',
+	properties: {
+		platform: {
+			type: 'string',
+			enum: ['1', '2'],
+		},
+		bid: {
+			type: 'string',
+		},
+	},
+	required: ['platform', 'bid'],
+	additionalProperties: false,
+};
+
+export const isBannersGetNewProps = ajv.compile<BannersGetNew>(BannersGetNewSchema);
+
+type BannersId = {
+	platform: BannerPlatform;
+};
+
+const BannersIdSchema = {
+	type: 'object',
+	properties: {
+		platform: {
+			type: 'string',
+		},
+	},
+	required: ['platform'],
+	additionalProperties: false,
+};
+
+export const isBannersIdProps = ajv.compile<BannersId>(BannersIdSchema);
+
+type Banners = {
+	platform: BannerPlatform;
+};
+
+const BannersSchema = {
+	type: 'object',
+	properties: {
+		platform: {
+			type: 'string',
+		},
+	},
+	required: ['platform'],
+	additionalProperties: false,
+};
+
+export const isBannersProps = ajv.compile<Banners>(BannersSchema);
+
+type BannersDismiss = {
+	bannerId: string;
+};
+
+const BannersDismissSchema = {
+	type: 'object',
+	properties: {
+		bannerId: {
+			type: 'string',
+		},
+	},
+	required: ['bannerId'],
+	additionalProperties: false,
+};
+
+export const isBannersDismissProps = ajv.compile<BannersDismiss>(BannersDismissSchema);
+
 export type BannersEndpoints = {
 	/* @deprecated */
 	'banners.getNew': {
-		GET: (params: { platform: BannerPlatform; bid: IBanner['_id'] }) => {
+		GET: (params: BannersGetNew) => {
 			banners: IBanner[];
 		};
 	};
 
 	'banners/:id': {
-		GET: (params: { platform: BannerPlatform }) => {
+		GET: (params: BannersId) => {
 			banners: IBanner[];
 		};
 	};
 
 	'banners': {
-		GET: (params: { platform: BannerPlatform }) => {
+		GET: (params: Banners) => {
 			banners: IBanner[];
 		};
 	};
 
 	'banners.dismiss': {
-		POST: (params: { bannerId: string }) => void;
+		POST: (params: BannersDismiss) => void;
 	};
 };