[BREAK] Move Multiple Department Creation to EE & [NEW] Department Archive

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

@@ -1,17 +1,19 @@
 import { isGETLivechatDepartmentProps, isPOSTLivechatDepartmentProps } from '@rocket.chat/rest-typings';
 import { Match, check } from 'meteor/check';
+import { LivechatDepartment, LivechatDepartmentAgents } from '@rocket.chat/models';
 
 import { API } from '../../../../api/server';
 import { hasPermission } from '../../../../authorization/server';
-import { LivechatDepartment, LivechatDepartmentAgents } from '../../../../models/server';
 import { Livechat } from '../../../server/lib/Livechat';
 import {
 	findDepartments,
 	findDepartmentById,
 	findDepartmentsToAutocomplete,
 	findDepartmentsBetweenIds,
 	findDepartmentAgents,
+	findArchivedDepartments,
 } from '../../../server/api/lib/departments';
+import { LivechatEnterprise } from '../../../../../ee/app/livechat-enterprise/server/lib/LivechatEnterprise';
 import { DepartmentHelper } from '../../../server/lib/Departments';
 
 API.v1.addRoute(
@@ -29,12 +31,13 @@ API.v1.addRoute(
 			const { offset, count } = this.getPaginationItems();
 			const { sort } = this.parseJsonQuery();
 
-			const { text, enabled, onlyMyDepartments, excludeDepartmentId } = this.queryParams;
+			const { text, enabled, onlyMyDepartments, excludeDepartmentId, showArchived } = this.queryParams;
 
 			const { departments, total } = await findDepartments({
 				userId: this.userId,
 				text,
 				enabled: enabled === 'true',
+				showArchived: showArchived === 'true',
 				onlyMyDepartments: onlyMyDepartments === 'true',
 				excludeDepartmentId,
 				pagination: {
@@ -55,12 +58,12 @@ API.v1.addRoute(
 			});
 
 			const agents = this.bodyParams.agents ? { upsert: this.bodyParams.agents } : {};
-			const department = Livechat.saveDepartment(null, this.bodyParams.department, agents);
+			const department = await LivechatEnterprise.saveDepartment(null, this.bodyParams.department, agents);
 
 			if (department) {
 				return API.v1.success({
 					department,
-					agents: LivechatDepartmentAgents.find({ departmentId: department._id }).fetch(),
+					agents: await LivechatDepartmentAgents.find({ departmentId: department._id }).toArray(),
 				});
 			}
 
@@ -118,7 +121,7 @@ API.v1.addRoute(
 
 			let success;
 			if (permissionToSave) {
-				success = Livechat.saveDepartment(_id, department);
+				success = await LivechatEnterprise.saveDepartment(_id, department);
 			}
 
 			if (success && agents && permissionToAddAgents) {
@@ -127,8 +130,8 @@ API.v1.addRoute(
 
 			if (success) {
 				return API.v1.success({
-					department: LivechatDepartment.findOneById(_id),
-					agents: LivechatDepartmentAgents.find({ departmentId: _id }).fetch(),
+					department: await LivechatDepartment.findOneById(_id),
+					agents: await LivechatDepartmentAgents.find({ departmentId: _id }).toArray(),
 				});
 			}
 
@@ -146,12 +149,79 @@ API.v1.addRoute(
 	},
 );
 
+API.v1.addRoute(
+	'livechat/departments/archived',
+	{
+		authRequired: true,
+		validateParams: { GET: isGETLivechatDepartmentProps },
+		permissionsRequired: {
+			GET: { permissions: ['view-livechat-departments', 'view-l-room'], operation: 'hasAny' },
+		},
+	},
+	{
+		async get() {
+			const { offset, count } = this.getPaginationItems();
+			const { sort } = this.parseJsonQuery();
+
+			const { text, onlyMyDepartments, excludeDepartmentId } = this.queryParams;
+
+			const { departments, total } = await findArchivedDepartments({
+				userId: this.userId,
+				text,
+				onlyMyDepartments: onlyMyDepartments === 'true',
+				excludeDepartmentId,
+				pagination: {
+					offset,
+					count,
+					sort: sort as any,
+				},
+			});
+
+			return API.v1.success({ departments, count: departments.length, offset, total });
+		},
+	},
+);
+
+API.v1.addRoute(
+	'livechat/department/:_id/archive',
+	{
+		authRequired: true,
+		permissionsRequired: ['manage-livechat-departments'],
+	},
+	{
+		async post() {
+			if (await Livechat.archiveDepartment(this.urlParams._id)) {
+				return API.v1.success();
+			}
+
+			return API.v1.failure();
+		},
+	},
+);
+
+API.v1.addRoute(
+	'livechat/department/:_id/unarchive',
+	{
+		authRequired: true,
+		permissionsRequired: ['manage-livechat-departments'],
+	},
+	{
+		async post() {
+			if (await Livechat.unarchiveDepartment(this.urlParams._id)) {
+				return API.v1.success();
+			}
+
+			return API.v1.failure();
+		},
+	},
+);
+
 API.v1.addRoute(
 	'livechat/department.autocomplete',
 	{ authRequired: true, permissionsRequired: { GET: { permissions: ['view-livechat-departments', 'view-l-room'], operation: 'hasAny' } } },
 	{
 		async get() {
-			const { selector, onlyMyDepartments } = this.queryParams;
+			const { selector, onlyMyDepartments, showArchived } = this.queryParams;
 			if (!selector) {
 				return API.v1.failure("The 'selector' param is required");
 			}
@@ -161,14 +231,15 @@ API.v1.addRoute(
 					uid: this.userId,
 					selector: JSON.parse(selector),
 					onlyMyDepartments: onlyMyDepartments === 'true',
+					showArchived: showArchived === 'true',
 				}),
 			);
 		},
 	},
 );
 
 API.v1.addRoute(
-	'livechat/department/:departmentId/agents',
+	'livechat/department/:_id/agents',
 	{
 		authRequired: true,
 		permissionsRequired: {
@@ -179,15 +250,15 @@ API.v1.addRoute(
 	{
 		async get() {
 			check(this.urlParams, {
-				departmentId: String,
+				_id: String,
 			});
 
 			const { offset, count } = this.getPaginationItems();
 			const { sort } = this.parseJsonQuery();
 
 			const agents = await findDepartmentAgents({
 				userId: this.userId,
-				departmentId: this.urlParams.departmentId,
+				departmentId: this.urlParams._id,
 				pagination: {
 					offset,
 					count,
@@ -199,7 +270,7 @@ API.v1.addRoute(
 		},
 		async post() {
 			check(this.urlParams, {
-				departmentId: String,
+				_id: String,
 			});
 
 			check(
@@ -209,7 +280,7 @@ API.v1.addRoute(
 					remove: Array,
 				}),
 			);
-			Livechat.saveDepartmentAgents(this.urlParams.departmentId, this.bodyParams);
+			Livechat.saveDepartmentAgents(this.urlParams._id, this.bodyParams);
 
 			return API.v1.success();
 		},
@@ -239,3 +310,18 @@ API.v1.addRoute(
 		},
 	},
 );
+API.v1.addRoute(
+	'livechat/department/isDepartmentCreationAvailable',
+	{
+		authRequired: true,
+		permissionsRequired: {
+			GET: { permissions: ['view-livechat-departments', 'manage-livechat-departments'], operation: 'hasAny' },
+		},
+	},
+	{
+		async get() {
+			const isDepartmentCreationAvailable = await LivechatEnterprise.isDepartmentCreationAvailable();
+			return API.v1.success({ isDepartmentCreationAvailable });
+		},
+	},
+);

apps/meteor/app/livechat/server/api/lib/departments.ts

@@ -14,6 +14,7 @@ type FindDepartmentParams = {
 	text?: string;
 	enabled?: boolean;
 	excludeDepartmentId?: string;
+	showArchived?: boolean;
 } & Pagination<ILivechatDepartmentRecord>;
 type FindDepartmentByIdParams = {
 	userId: string;
@@ -29,6 +30,7 @@ type FindDepartmentToAutocompleteParams = {
 		term: string;
 	};
 	onlyMyDepartments?: boolean;
+	showArchived?: boolean;
 };
 type FindDepartmentAgentsParams = {
 	userId: string;
@@ -41,10 +43,12 @@ export async function findDepartments({
 	text,
 	enabled,
 	excludeDepartmentId,
+	showArchived = false,
 	pagination: { offset, count, sort },
 }: FindDepartmentParams): Promise<PaginatedResult<{ departments: ILivechatDepartmentRecord[] }>> {
 	let query = {
 		$or: [{ type: { $eq: 'd' } }, { type: { $exists: false } }],
+		...(!showArchived && { archived: { $ne: !showArchived } }),
 		...(enabled && { enabled: Boolean(enabled) }),
 		...(text && { name: new RegExp(escapeRegExp(text), 'i') }),
 		...(excludeDepartmentId && { _id: { $ne: excludeDepartmentId } }),
@@ -70,6 +74,40 @@ export async function findDepartments({
 	};
 }
 
+export async function findArchivedDepartments({
+	userId,
+	onlyMyDepartments = false,
+	text,
+	excludeDepartmentId,
+	pagination: { offset, count, sort },
+}: FindDepartmentParams): Promise<PaginatedResult<{ departments: ILivechatDepartmentRecord[] }>> {
+	let query = {
+		$or: [{ type: { $eq: 'd' } }, { type: { $exists: false } }],
+		archived: { $eq: true },
+		...(text && { name: new RegExp(escapeRegExp(text), 'i') }),
+		...(excludeDepartmentId && { _id: { $ne: excludeDepartmentId } }),
+	};
+
+	if (onlyMyDepartments) {
+		query = callbacks.run('livechat.applyDepartmentRestrictions', query, { userId });
+	}
+
+	const { cursor, totalCount } = LivechatDepartment.findPaginated(query, {
+		sort: sort || { name: 1 },
+		skip: offset,
+		limit: count,
+	});
+
+	const [departments, total] = await Promise.all([cursor.toArray(), totalCount]);
+
+	return {
+		departments,
+		count: departments.length,
+		offset,
+		total,
+	};
+}
+
 export async function findDepartmentById({
 	userId,
 	departmentId,
@@ -102,6 +140,7 @@ export async function findDepartmentsToAutocomplete({
 	uid,
 	selector,
 	onlyMyDepartments = false,
+	showArchived = false,
 }: FindDepartmentToAutocompleteParams): Promise<{ items: ILivechatDepartmentRecord[] }> {
 	const { exceptions = [] } = selector;
 	let { conditions = {} } = selector;
@@ -110,7 +149,9 @@ export async function findDepartmentsToAutocomplete({
 		conditions = callbacks.run('livechat.applyDepartmentRestrictions', conditions, { userId: uid });
 	}
 
-	const items = await LivechatDepartment.findByNameRegexWithExceptionsAndConditions(selector.term, exceptions, conditions, {
+	const conditionsWithArchived = { archived: { $ne: !showArchived }, ...conditions };
+
+	const items = await LivechatDepartment.findByNameRegexWithExceptionsAndConditions(selector.term, exceptions, conditionsWithArchived, {
 		projection: {
 			_id: 1,
 			name: 1,

apps/meteor/app/livechat/server/config.ts

@@ -413,6 +413,15 @@ Meteor.startup(function () {
 			enableQuery: [{ _id: 'Livechat_enable_transcript', value: true }, omnichannelEnabledQuery],
 		});
 
+		this.add('Omnichannel_enable_department_removal', false, {
+			type: 'boolean',
+			group: 'Omnichannel',
+			public: true,
+			i18nLabel: 'Omnichannel_enable_department_removal',
+			alert: 'Omnichannel_enable_department_removal_alert',
+			enableQuery: omnichannelEnabledQuery,
+		});
+
 		this.add('Livechat_registration_form_message', '', {
 			type: 'string',
 			group: 'Omnichannel',