chore: improve some omnichannel types

RocketChat · Oct 22, 2024 · 304b890 · 304b890
1 parent fd5e54f
commit 304b890
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 73 deletions.
diff --git a/apps/meteor/app/livechat/imports/server/rest/sms.ts b/apps/meteor/app/livechat/imports/server/rest/sms.ts
@@ -1,12 +1,12 @@
 import { OmnichannelIntegration } from '@rocket.chat/core-services';
 import type {
 	ILivechatVisitor,
-	IOmnichannelRoom,
 	IUpload,
 	MessageAttachment,
 	ServiceData,
 	FileAttachmentProps,
 	IOmnichannelSource,
+	IOmnichannelRoomInfo,
 } from '@rocket.chat/core-typings';
 import { OmnichannelSourceType } from '@rocket.chat/core-typings';
 import { Logger } from '@rocket.chat/logger';
@@ -137,10 +137,7 @@ API.v1.addRoute('livechat/sms-incoming/:service', {
 			return API.v1.success(SMSService.error(new Error('Invalid visitor')));
 		}
 
-		const roomInfo: {
-			source?: IOmnichannelRoom['source'];
-			[key: string]: unknown;
-		} = {
+		const roomInfo: IOmnichannelRoomInfo = {
 			sms: {
 				from: sms.to,
 			},
@@ -259,10 +256,7 @@ API.v1.addRoute('livechat/sms-incoming/:service', {
 		const sendMessage: {
 			guest: ILivechatVisitor;
 			message: ILivechatMessage;
-			roomInfo: {
-				source?: IOmnichannelRoom['source'];
-				[key: string]: unknown;
-			};
+			roomInfo: IOmnichannelRoomInfo;
 		} = {
 			guest: visitor,
 			roomInfo,

diff --git a/apps/meteor/app/livechat/server/api/v1/room.ts b/apps/meteor/app/livechat/server/api/v1/room.ts
@@ -1,5 +1,5 @@
 import { Omnichannel } from '@rocket.chat/core-services';
-import type { ILivechatAgent, IUser, SelectedAgent, TransferByData } from '@rocket.chat/core-typings';
+import type { ILivechatAgent, IOmnichannelInquiryExtraData, IUser, SelectedAgent, TransferByData } from '@rocket.chat/core-typings';
 import { isOmnichannelRoom, OmnichannelSourceType } from '@rocket.chat/core-typings';
 import { LivechatVisitors, Users, LivechatRooms, Messages } from '@rocket.chat/models';
 import {
@@ -80,7 +80,12 @@ API.v1.addRoute(
 					},
 				};
 
-				const newRoom = await LivechatTyped.createRoom({ visitor: guest, roomInfo, agent, extraData: extraParams });
+				const newRoom = await LivechatTyped.createRoom({
+					visitor: guest,
+					roomInfo,
+					agent,
+					extraData: extraParams as IOmnichannelInquiryExtraData,
+				});
 
 				return API.v1.success({
 					room: newRoom,

diff --git a/apps/meteor/app/livechat/server/lib/Helper.ts b/apps/meteor/app/livechat/server/lib/Helper.ts
@@ -13,6 +13,9 @@ import type {
 	TransferByData,
 	ILivechatAgent,
 	ILivechatDepartment,
+	IOmnichannelRoomInfo,
+	IOmnichannelInquiryExtraData,
+	IOmnichannelRoomExtraData,
 } from '@rocket.chat/core-typings';
 import { LivechatInquiryStatus, OmnichannelSourceType, DEFAULT_SLA_CONFIG, UserStatus } from '@rocket.chat/core-typings';
 import { LivechatPriorityWeight } from '@rocket.chat/core-typings/src/ILivechatPriority';
@@ -60,18 +63,12 @@ export const allowAgentSkipQueue = (agent: SelectedAgent) => {
 
 	return hasRoleAsync(agent.agentId, 'bot');
 };
-export const createLivechatRoom = async <
-	E extends Record<string, unknown> & {
-		sla?: string;
-		customFields?: Record<string, unknown>;
-		source?: OmnichannelSourceType;
-	},
->(
+export const createLivechatRoom = async (
 	rid: string,
 	name: string,
 	guest: ILivechatVisitor,
-	roomInfo: Partial<IOmnichannelRoom> = {},
-	extraData?: E,
+	roomInfo: IOmnichannelRoomInfo = {},
+	extraData?: IOmnichannelRoomExtraData,
 ) => {
 	check(rid, String);
 	check(name, String);
@@ -163,7 +160,7 @@ export const createLivechatInquiry = async ({
 	guest?: Pick<ILivechatVisitor, '_id' | 'username' | 'status' | 'department' | 'name' | 'token' | 'activity'>;
 	message?: string;
 	initialStatus?: LivechatInquiryStatus;
-	extraData?: Pick<ILivechatInquiryRecord, 'source'>;
+	extraData?: IOmnichannelInquiryExtraData;
 }) => {
 	check(rid, String);
 	check(name, String);

diff --git a/apps/meteor/app/livechat/server/lib/LivechatTyped.ts b/apps/meteor/app/livechat/server/lib/LivechatTyped.ts
@@ -18,6 +18,8 @@ import type {
 	ILivechatInquiryRecord,
 	ILivechatContact,
 	ILivechatContactChannel,
+	IOmnichannelRoomInfo,
+	IOmnichannelRoomExtraData,
 } from '@rocket.chat/core-typings';
 import { OmnichannelSourceType, ILivechatAgentStatus, UserStatus, isOmnichannelRoom } from '@rocket.chat/core-typings';
 import { Logger, type MainLogger } from '@rocket.chat/logger';
@@ -374,12 +376,9 @@ class LivechatClass {
 		visitor: ILivechatVisitor;
 		message?: string;
 		rid?: string;
-		roomInfo: {
-			source?: IOmnichannelRoom['source'];
-			[key: string]: unknown;
-		};
+		roomInfo: IOmnichannelRoomInfo;
 		agent?: SelectedAgent;
-		extraData?: Record<string, unknown>;
+		extraData?: IOmnichannelRoomExtraData;
 	}) {
 		if (!settings.get('Livechat_enabled')) {
 			throw new Meteor.Error('error-omnichannel-is-disabled');
@@ -465,21 +464,12 @@ class LivechatClass {
 		return room;
 	}
 
-	async getRoom<
-		E extends Record<string, unknown> & {
-			sla?: string;
-			customFields?: Record<string, unknown>;
-			source?: OmnichannelSourceType;
-		},
-	>(
+	async getRoom(
 		guest: ILivechatVisitor,
 		message: Pick<IMessage, 'rid' | 'msg' | 'token'>,
-		roomInfo: {
-			source?: IOmnichannelRoom['source'];
-			[key: string]: unknown;
-		},
+		roomInfo: IOmnichannelRoomInfo,
 		agent?: SelectedAgent,
-		extraData?: E,
+		extraData?: IOmnichannelRoomExtraData,
 	) {
 		if (!settings.get('Livechat_enabled')) {
 			throw new Meteor.Error('error-omnichannel-is-disabled');
@@ -1120,10 +1110,7 @@ class LivechatClass {
 	}: {
 		guest: ILivechatVisitor;
 		message: ILivechatMessage;
-		roomInfo: {
-			source?: IOmnichannelRoom['source'];
-			[key: string]: unknown;
-		};
+		roomInfo: IOmnichannelRoomInfo;
 		agent?: SelectedAgent;
 	}) {
 		const { room, newRoom } = await this.getRoom(guest, message, roomInfo, agent);

diff --git a/apps/meteor/app/livechat/server/lib/QueueManager.ts b/apps/meteor/app/livechat/server/lib/QueueManager.ts
@@ -1,13 +1,12 @@
 import { Apps, AppEvents } from '@rocket.chat/apps';
 import { Omnichannel } from '@rocket.chat/core-services';
-import type { ILivechatDepartment } from '@rocket.chat/core-typings';
+import type { ILivechatDepartment, IOmnichannelRoomInfo, IOmnichannelRoomExtraData } from '@rocket.chat/core-typings';
 import {
 	LivechatInquiryStatus,
 	type ILivechatInquiryRecord,
 	type ILivechatVisitor,
 	type IOmnichannelRoom,
 	type SelectedAgent,
-	type OmnichannelSourceType,
 } from '@rocket.chat/core-typings';
 import { Logger } from '@rocket.chat/logger';
 import { LivechatDepartment, LivechatDepartmentAgents, LivechatInquiry, LivechatRooms, Users } from '@rocket.chat/models';
@@ -146,29 +145,20 @@ export class QueueManager {
 		await this.dispatchInquiryQueued(inquiry, room, defaultAgent);
 	}
 
-	static async requestRoom<
-		E extends Record<string, unknown> & {
-			sla?: string;
-			customFields?: Record<string, unknown>;
-			source?: OmnichannelSourceType;
-		},
-	>({
+	static async requestRoom({
 		guest,
 		rid = Random.id(),
 		message,
 		roomInfo,
 		agent,
-		extraData: { customFields, ...extraData } = {} as E,
+		extraData: { customFields, ...extraData } = {},
 	}: {
 		guest: ILivechatVisitor;
 		rid?: string;
 		message?: string;
-		roomInfo: {
-			source?: IOmnichannelRoom['source'];
-			[key: string]: unknown;
-		};
+		roomInfo: IOmnichannelRoomInfo;
 		agent?: SelectedAgent;
-		extraData?: E;
+		extraData?: IOmnichannelRoomExtraData;
 	}) {
 		logger.debug(`Requesting a room for guest ${guest._id}`);
 		check(
@@ -222,7 +212,7 @@ export class QueueManager {
 			}
 		}
 
-		const name = (roomInfo?.fname as string) || guest.name || guest.username;
+		const name = guest.name || guest.username;
 
 		const room = await createLivechatRoom(rid, name, { ...guest, ...(department && { department }) }, roomInfo, {
 			...extraData,

diff --git a/apps/meteor/lib/callbacks.ts b/apps/meteor/lib/callbacks.ts
@@ -21,7 +21,9 @@ import type {
 	UserStatus,
 	ILivechatDepartment,
 	MessageMention,
-	OmnichannelSourceType,
+	IOmnichannelRoomInfo,
+	IOmnichannelInquiryExtraData,
+	IOmnichannelRoomExtraData,
 } from '@rocket.chat/core-typings';
 import type { Updater } from '@rocket.chat/models';
 import type { FilterOperators } from 'mongodb';
@@ -108,10 +110,7 @@ interface EventLikeCallbackSignatures {
  * TODO: develop a middleware alternative and grant independence of execution order
  */
 type ChainedCallbackSignatures = {
-	'livechat.beforeRoom': (
-		roomInfo: Record<string, unknown>,
-		extraData?: Record<string, unknown> & { sla?: string },
-	) => Record<string, unknown>;
+	'livechat.beforeRoom': (roomInfo: IOmnichannelRoomInfo, extraData?: IOmnichannelRoomExtraData) => Partial<IOmnichannelRoom>;
 	'livechat.newRoom': (room: IOmnichannelRoom) => IOmnichannelRoom;
 
 	'livechat.beforeForwardRoomToDepartment': <T extends { room: IOmnichannelRoom; transferData?: { department: { _id: string } } }>(
@@ -207,15 +206,7 @@ type ChainedCallbackSignatures = {
 			options: { forwardingToDepartment?: { oldDepartmentId?: string; transferData?: any }; clientAction?: boolean };
 		},
 	) => Promise<(IOmnichannelRoom & { chatQueued: boolean }) | undefined>;
-	'livechat.beforeInquiry': (
-		data: Pick<ILivechatInquiryRecord, 'source'> & { sla?: string; priority?: string; [other: string]: unknown } & {
-			customFields?: Record<string, unknown>;
-			source?: OmnichannelSourceType;
-		},
-	) => Pick<ILivechatInquiryRecord, 'source'> & { sla?: string; priority?: string; [other: string]: unknown } & {
-		customFields?: Record<string, unknown>;
-		source?: OmnichannelSourceType;
-	};
+	'livechat.beforeInquiry': (data: IOmnichannelInquiryExtraData) => Partial<ILivechatInquiryRecord>;
 	'roomNameChanged': (room: IRoom) => void;
 	'roomTopicChanged': (room: IRoom) => void;
 	'roomAnnouncementChanged': (room: IRoom) => void;

diff --git a/packages/core-typings/src/IRoom.ts b/packages/core-typings/src/IRoom.ts
@@ -205,7 +205,7 @@ export interface IOmnichannelGenericRoom extends Omit<IRoom, 'default' | 'featur
 		inbox: string;
 		thread: string[];
 		replyTo: string;
-		subject: string;
+		subject?: string;
 	};
 	source: IOmnichannelSource;
 
@@ -362,6 +362,12 @@ export const isOmnichannelSourceFromApp = (source: IOmnichannelSource): source i
 	return source?.type === OmnichannelSourceType.APP;
 };
 
+export type IOmnichannelRoomInfo = Pick<Partial<IOmnichannelRoom>, 'source' | 'sms' | 'email'>;
+
+export type IOmnichannelRoomExtraData = Pick<Partial<IOmnichannelRoom>, 'customFields' | 'source'> & { sla?: string };
+
+export type IOmnichannelInquiryExtraData = IOmnichannelRoomExtraData & { priority?: string };
+
 export type RoomAdminFieldsType =
 	| '_id'
 	| 'prid'