[NEW] Capability to search visitors by custom fields

apps/meteor/app/livechat/imports/server/rest/visitors.js

@@ -8,7 +8,7 @@ import {
 	findChatHistory,
 	searchChats,
 	findVisitorsToAutocomplete,
-	findVisitorsByEmailOrPhoneOrNameOrUsername,
+	findVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField,
 } from '../../../server/api/lib/visitors';
 
 API.v1.addRoute(
@@ -154,7 +154,7 @@ API.v1.addRoute(
 			const nameOrUsername = new RegExp(escapeRegExp(term), 'i');
 
 			return API.v1.success(
-				await findVisitorsByEmailOrPhoneOrNameOrUsername({
+				await findVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField({
 					userId: this.userId,
 					emailOrPhone: term,
 					nameOrUsername,

apps/meteor/app/livechat/server/api/lib/visitors.js

@@ -146,7 +146,7 @@ export async function findVisitorsToAutocomplete({ userId, selector }) {
 	};
 }
 
-export async function findVisitorsByEmailOrPhoneOrNameOrUsername({
+export async function findVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField({
 	userId,
 	emailOrPhone,
 	nameOrUsername,
@@ -156,19 +156,23 @@ export async function findVisitorsByEmailOrPhoneOrNameOrUsername({
 		throw new Error('error-not-authorized');
 	}
 
-	const { cursor, totalCount } = LivechatVisitors.findPaginatedVisitorsByEmailOrPhoneOrNameOrUsername(emailOrPhone, nameOrUsername, {
-		sort: sort || { ts: -1 },
-		skip: offset,
-		limit: count,
-		projection: {
-			username: 1,
-			name: 1,
-			phone: 1,
-			livechatData: 1,
-			visitorEmails: 1,
-			lastChat: 1,
+	const { cursor, totalCount } = await LivechatVisitors.findPaginatedVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField(
+		emailOrPhone,
+		nameOrUsername,
+		{
+			sort: sort || { ts: -1 },
+			skip: offset,
+			limit: count,
+			projection: {
+				username: 1,
+				name: 1,
+				phone: 1,
+				livechatData: 1,
+				visitorEmails: 1,
+				lastChat: 1,
+			},
 		},
-	});
+	);
 
 	const [visitors, total] = await Promise.all([cursor.toArray(), totalCount]);
 

apps/meteor/app/livechat/server/api/v1/contact.ts

@@ -1,6 +1,6 @@
 import { Match, check } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
-import { LivechatVisitors } from '@rocket.chat/models';
+import { LivechatCustomField, LivechatVisitors } from '@rocket.chat/models';
 
 import { API } from '../../../../api/server';
 import { Contacts } from '../../lib/Contacts';
@@ -47,19 +47,39 @@ API.v1.addRoute(
 			check(this.queryParams, {
 				email: Match.Maybe(String),
 				phone: Match.Maybe(String),
+				custom: Match.Maybe(String),
 			});
+			const { email, phone, custom } = this.queryParams;
 
-			const { email, phone } = this.queryParams;
-
-			if (!email && !phone) {
+			if (!email && !phone && !custom) {
 				throw new Meteor.Error('error-invalid-params');
 			}
+			let foundCF = {};
+			if (custom) {
+				const customObj = Object.fromEntries(
+					Array.from(new URLSearchParams(custom)).filter(([k, v]) => typeof k === 'string' && typeof v === 'string'),
+				);
+
+				foundCF = Object.fromEntries(
+					(
+						await LivechatCustomField.find(
+							{ scope: 'visitor', searchable: true, _id: { $in: Object.keys(customObj) } },
+							{
+								projection: {
+									_id: 1,
+								},
+							},
+						).toArray()
+					).map(({ _id }) => [_id, customObj[_id]]),
+				);
+			}
 
 			const query = Object.assign(
 				{},
 				{
 					...(email && { visitorEmails: { address: email } }),
 					...(phone && { phone: { phoneNumber: phone } }),
+					...(custom && { livechatData: foundCF }),
 				},
 			);
 

apps/meteor/app/models/server/models/LivechatRooms.js

@@ -33,6 +33,7 @@ export class LivechatRooms extends Base {
 				},
 			},
 		);
+		this.tryEnsureIndex({ 'livechatData.$**': 1 });
 	}
 
 	findOneByIdOrName(_idOrName, options) {

apps/meteor/client/views/omnichannel/customFields/CustomFieldsForm.js

@@ -5,9 +5,9 @@ import React, { useMemo } from 'react';
 const CustomFieldsForm = ({ values = {}, handlers = {}, className }) => {
 	const t = useTranslation();
 
-	const { id, field, label, scope, visibility, regexp } = values;
+	const { id, field, label, scope, visibility, searchable, regexp } = values;
 
-	const { handleField, handleLabel, handleScope, handleVisibility, handleRegexp } = handlers;
+	const { handleField, handleLabel, handleScope, handleVisibility, handleSearchable, handleRegexp } = handlers;
 
 	const scopeOptions = useMemo(
 		() => [
@@ -45,6 +45,14 @@ const CustomFieldsForm = ({ values = {}, handlers = {}, className }) => {
 					</Field.Row>
 				</Box>
 			</Field>
+			<Field className={className}>
+				<Box display='flex' flexDirection='row'>
+					<Field.Label htmlFor='searchable'>{t('Searchable')}</Field.Label>
+					<Field.Row>
+						<ToggleSwitch id='searchable' checked={searchable} onChange={handleSearchable} />
+					</Field.Row>
+				</Box>
+			</Field>
 			<Field className={className}>
 				<Field.Label>{t('Validation')}</Field.Label>
 				<Field.Row>

apps/meteor/client/views/omnichannel/customFields/EditCustomFieldsPage.js

@@ -14,6 +14,7 @@ const getInitialValues = (cf) => ({
 	label: cf.label,
 	scope: cf.scope,
 	visibility: cf.visibility === 'visible',
+	searchable: !!cf.searchable,
 	regexp: cf.regexp,
 });
 

apps/meteor/packages/rocketchat-i18n/i18n/en.i18n.json

@@ -4008,6 +4008,7 @@
   "Screen_Share": "Screen Share",
   "Script_Enabled": "Script Enabled",
   "Search": "Search",
+  "Searchable": "Searchable",
   "Search_Apps": "Search Apps",
   "Search_by_file_name": "Search by file name",
   "Search_by_username": "Search by username",

apps/meteor/packages/rocketchat-i18n/i18n/pt-BR.i18n.json

@@ -3837,6 +3837,7 @@
   "Screen_Share": "Compartilhamento de tela",
   "Script_Enabled": "Script ativado",
   "Search": "Pesquisar",
+  "Searchable": "Pesquisável",
   "Search_Apps": "Pesquisar aplicativos",
   "Search_by_file_name": "Pesquisar por nome de arquivo",
   "Search_by_username": "Pesquisar por nome de usuário",

apps/meteor/server/models/raw/LivechatVisitors.ts

@@ -13,7 +13,7 @@ import type {
 	DeleteResult,
 	UpdateFilter,
 } from 'mongodb';
-import { Settings } from '@rocket.chat/models';
+import { Settings, LivechatCustomField } from '@rocket.chat/models';
 import { escapeRegExp } from '@rocket.chat/string-helpers';
 
 import { BaseRaw } from './BaseRaw';
@@ -31,6 +31,7 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 			{ key: { name: 1 }, sparse: true },
 			{ key: { username: 1 } },
 			{ key: { 'contactMananger.username': 1 }, sparse: true },
+			{ key: { 'livechatData.$**': 1 } },
 		];
 	}
 
@@ -159,11 +160,16 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 	/**
 	 * Find visitors by their email or phone or username or name
 	 */
-	findPaginatedVisitorsByEmailOrPhoneOrNameOrUsername(
+	async findPaginatedVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField(
 		emailOrPhone: string,
 		nameOrUsername: RegExp,
 		options: FindOptions<ILivechatVisitor>,
-	): FindPaginated<FindCursor<ILivechatVisitor>> {
+	): Promise<FindPaginated<FindCursor<ILivechatVisitor>>> {
+		const allowedCF = LivechatCustomField.find({ scope: 'visitor', searchable: true }, { projection: { fields: { _id: 1 } } }).map(
+			({ _id }) => _id,
+		);
+
+		const filter = new RegExp(emailOrPhone, 'i');
 		const query = {
 			$or: [
 				{
@@ -178,6 +184,7 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 				{
 					username: nameOrUsername,
 				},
+				...(await allowedCF.toArray().then((cf) => cf.map((c: string) => ({ [`livechatData.${c}`]: filter })))),
 			],
 		};
 

packages/core-typings/src/ILivechatCustomField.ts

@@ -10,4 +10,5 @@ export interface ILivechatCustomField extends IRocketChatRecord {
 	defaultValue?: string;
 	options?: string;
 	public?: boolean;
+	searchable?: boolean;
 }

packages/model-typings/src/models/ILivechatVisitorsModel.ts

@@ -17,11 +17,11 @@ export interface ILivechatVisitorsModel extends IBaseModel<ILivechatVisitor> {
 			custom_name: string;
 		}
 	>;
-	findPaginatedVisitorsByEmailOrPhoneOrNameOrUsername(
+	findPaginatedVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField(
 		emailOrPhone: string,
 		nameOrUsername: RegExp,
 		options: FindOptions<ILivechatVisitor>,
-	): FindPaginated<FindCursor<ILivechatVisitor>>;
+	): Promise<FindPaginated<FindCursor<ILivechatVisitor>>>;
 
 	removeContactManagerByUsername(manager: string): Promise<UpdateResult | Document>;