chore: adds deprecation warning for livechat:removeBusinessHour and new endpoint to replace it

.changeset/weak-frogs-relax.md

@@ -0,0 +1,6 @@
+---
+"@rocket.chat/meteor": patch
+"@rocket.chat/rest-typings": patch
+---
+
+Adds deprecation warning for `livechat:removeBusinessHour` and new endpoint to replace it; `livechat/business-hours.remove`

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

@@ -2,6 +2,8 @@ import type { ILivechatBusinessHour } from '@rocket.chat/core-typings';
 import {
 	isGETBusinessHourParams,
 	isPOSTLivechatBusinessHoursSaveParams,
+	isPOSTLivechatBusinessHoursRemoveParams,
+	POSTLivechatBusinessHoursRemoveSuccessResponse,
 	POSTLivechatBusinessHoursSaveSuccessResponse,
 	validateBadRequestErrorResponse,
 	validateUnauthorizedErrorResponse,
@@ -26,26 +28,46 @@ API.v1.addRoute(
 	},
 );
 
-const livechatBusinessHoursEndpoints = API.v1.post(
-	'livechat/business-hours.save',
-	{
-		response: {
-			200: POSTLivechatBusinessHoursSaveSuccessResponse,
-			400: validateBadRequestErrorResponse,
-			401: validateUnauthorizedErrorResponse,
+const livechatBusinessHoursEndpoints = API.v1
+	.post(
+		'livechat/business-hours.save',
+		{
+			response: {
+				200: POSTLivechatBusinessHoursSaveSuccessResponse,
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+			},
+			authRequired: true,
+			body: isPOSTLivechatBusinessHoursSaveParams,
 		},
-		authRequired: true,
-		body: isPOSTLivechatBusinessHoursSaveParams,
-	},
-	async function action() {
-		const params = this.bodyParams;
+		async function action() {
+			const params = this.bodyParams;
 
-		// TODO: Remove typecasting after refactoring saveBusinessHour logic with proper type logic. See: CORE-1552
-		const result = await businessHourManager.saveBusinessHour(params as unknown as ILivechatBusinessHour);
+			// TODO: Remove typecasting after refactoring saveBusinessHour logic with proper type logic. See: CORE-1552
+			const result = await businessHourManager.saveBusinessHour(params as unknown as ILivechatBusinessHour);
 
-		return API.v1.success(result);
-	}
-);
+			return API.v1.success(result);
+		}
+	)
+	.post(
+		'livechat/business-hours.remove',
+		{
+			response: {
+				200: POSTLivechatBusinessHoursRemoveSuccessResponse,
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+			},
+			authRequired: true,
+			body: isPOSTLivechatBusinessHoursRemoveParams,
+		},
+		async function action() {
+			const { _id, type } = this.bodyParams;
+
+			await businessHourManager.removeBusinessHourByIdAndType(_id, type);
+
+			return API.v1.success();
+		}
+	);
 
 type LivechatBusinessHoursEndpoints = ExtractRoutesFromAPI<typeof livechatBusinessHoursEndpoints>;
 

apps/meteor/client/views/omnichannel/businessHours/useRemoveBusinessHour.tsx

@@ -1,20 +1,20 @@
 import { useEffectEvent } from '@rocket.chat/fuselage-hooks';
 import { GenericModal } from '@rocket.chat/ui-client';
-import { useSetModal, useToastMessageDispatch, useMethod } from '@rocket.chat/ui-contexts';
+import { useSetModal, useToastMessageDispatch, useEndpoint } from '@rocket.chat/ui-contexts';
 import { useQueryClient } from '@tanstack/react-query';
 import { useTranslation } from 'react-i18next';
 
 export const useRemoveBusinessHour = () => {
 	const { t } = useTranslation();
 	const setModal = useSetModal();
 	const dispatchToastMessage = useToastMessageDispatch();
-	const removeBusinessHour = useMethod('livechat:removeBusinessHour');
+	const removeBusinessHour = useEndpoint('POST', '/v1/livechat/business-hours.remove');
 	const queryClient = useQueryClient();
 
 	const handleRemove = useEffectEvent((_id: string, type: string) => {
 		const onDeleteBusinessHour = async () => {
 			try {
-				await removeBusinessHour(_id, type);
+				await removeBusinessHour({ _id, type });
 				dispatchToastMessage({ type: 'success', message: t('Business_Hour_Removed') });
 				queryClient.invalidateQueries({
 					queryKey: ['livechat-getBusinessHours'],

apps/meteor/ee/app/livechat-enterprise/server/methods/removeBusinessHour.ts

@@ -2,6 +2,7 @@ import type { ServerMethods } from '@rocket.chat/ddp-client';
 import { Meteor } from 'meteor/meteor';
 
 import { hasPermissionAsync } from '../../../../../app/authorization/server/functions/hasPermission';
+import { methodDeprecationLogger } from '../../../../../app/lib/server/lib/deprecationWarningLogger';
 import { businessHourManager } from '../../../../../app/livechat/server/business-hour';
 
 declare module '@rocket.chat/ddp-client' {
@@ -13,6 +14,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async 'livechat:removeBusinessHour'(id: string, type: string) {
+		methodDeprecationLogger.method('livechat:removeBusinessHour', '8.0.0', '/v1/livechat/business-hours.remove');
 		const userId = Meteor.userId();
 
 		if (!userId || !(await hasPermissionAsync(userId, 'view-livechat-business-hours'))) {

apps/meteor/tests/data/livechat/businessHours.ts

@@ -3,7 +3,7 @@ import { LivechatBusinessHourTypes } from '@rocket.chat/core-typings';
 import type { POSTLivechatBusinessHoursSaveParams } from '@rocket.chat/rest-typings';
 import moment from 'moment';
 
-import { api, credentials, methodCall, request } from '../api-data';
+import { api, credentials, request } from '../api-data';
 import { updateEESetting, updateSetting } from '../permissions.helper';
 
 type ISaveBhApiWorkHour = Omit<ILivechatBusinessHour, '_id' | 'ts' | 'timezone'> & {
@@ -132,17 +132,10 @@ export const disableDefaultBusinessHour = async () => {
 };
 
 const removeCustomBusinessHour = async (businessHourId: string) => {
-	await request
-		.post(methodCall('livechat:removeBusinessHour'))
+	return request
+		.post(api('livechat/business-hours.remove'))
 		.set(credentials)
-		.send({
-			message: JSON.stringify({
-				params: [businessHourId, LivechatBusinessHourTypes.CUSTOM],
-				msg: 'method',
-				method: 'livechat:removeBusinessHour',
-				id: '101',
-			}),
-		})
+		.send({ _id: businessHourId, type: LivechatBusinessHourTypes.CUSTOM })
 		.expect(200);
 };
 

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

@@ -3411,6 +3411,43 @@ export const POSTLivechatBusinessHoursSaveSuccessSchema = {
 
 export const POSTLivechatBusinessHoursSaveSuccessResponse = ajv.compile<void>(POSTLivechatBusinessHoursSaveSuccessSchema);
 
+type POSTLivechatBusinessHoursRemoveParams = {
+	_id: string;
+	type: string;
+};
+
+const POSTLivechatBusinessHoursRemoveParamsSchema = {
+	type: 'object',
+	properties: {
+		_id: {
+			type: 'string',
+		},
+		type: {
+			type: 'string',
+		},
+	},
+	required: ['_id', 'type'],
+	additionalProperties: false,
+};
+
+export const isPOSTLivechatBusinessHoursRemoveParams = ajv.compile<POSTLivechatBusinessHoursRemoveParams>(
+	POSTLivechatBusinessHoursRemoveParamsSchema,
+);
+
+export const POSTLivechatBusinessHoursRemoveSuccessSchema = {
+	type: 'object',
+	properties: {
+		success: {
+			type: 'boolean',
+			enum: [true],
+		},
+	},
+	required: ['success'],
+	additionalProperties: false,
+};
+
+export const POSTLivechatBusinessHoursRemoveSuccessResponse = ajv.compile<void>(POSTLivechatBusinessHoursRemoveSuccessSchema);
+
 export const isGETLivechatTriggersParams = ajv.compile<GETLivechatTriggersParams>(GETLivechatTriggersParamsSchema);
 
 export type GETLivechatRoomsParams = PaginatedRequest<{