add deprecation alerts for lead capture livechat features

Author: nazabucciarelli

.changeset/old-bottles-shave.md

@@ -0,0 +1,7 @@
+---
+'@rocket.chat/models': patch
+'@rocket.chat/i18n': patch
+'@rocket.chat/meteor': patch
+---
+
+Deprecates `Lead capture email regex` and `Lead capture phone regex` features.

apps/meteor/app/livechat/server/hooks/leadCapture.ts

@@ -30,6 +30,7 @@ function validateMessage(message: IMessage, room: IOmnichannelRoom) {
 	return true;
 }
 
+// TODO: Remove Livechat lead capture features in version 9.0.0
 callbacks.add(
 	'afterOmnichannelSaveMessage',
 	async (message, { room }) => {

apps/meteor/server/settings/omnichannel.ts

@@ -1,6 +1,7 @@
 import { SettingEditor } from '@rocket.chat/core-typings';
 
 import { settingsRegistry } from '../../app/settings/server';
+import { shouldBreakInVersion } from '../lib/shouldBreakInVersion';
 
 const omnichannelEnabledQuery = { _id: 'Livechat_enabled', value: true };
 
@@ -336,25 +337,32 @@ export const createOmniSettings = () =>
 			enableQuery: omnichannelEnabledQuery,
 		});
 
-		await this.add('Livechat_lead_email_regex', '\\b[A-Z0-9._%+-]+@(?:[A-Z0-9-]+\\.)+[A-Z]{2,4}\\b', {
-			type: 'string',
-			group: 'Omnichannel',
-			section: 'CRM_Integration',
-			i18nLabel: 'Lead_capture_email_regex',
-			enableQuery: omnichannelEnabledQuery,
-		});
-
-		await this.add(
-			'Livechat_lead_phone_regex',
-			'((?:\\([0-9]{1,3}\\)|[0-9]{2})[ \\-]*?[0-9]{4,5}(?:[\\-\\s\\_]{1,2})?[0-9]{4}(?:(?=[^0-9])|$)|[0-9]{4,5}(?:[\\-\\s\\_]{1,2})?[0-9]{4}(?:(?=[^0-9])|$))',
-			{
+		if (!shouldBreakInVersion('9.0.0')) {
+			// TODO: Remove Livechat lead capture features in version 9.0.0
+			await this.add('Livechat_lead_email_regex', '\\b[A-Z0-9._%+-]+@(?:[A-Z0-9-]+\\.)+[A-Z]{2,4}\\b', {
 				type: 'string',
 				group: 'Omnichannel',
 				section: 'CRM_Integration',
-				i18nLabel: 'Lead_capture_phone_regex',
+				i18nLabel: 'Lead_capture_email_regex',
 				enableQuery: omnichannelEnabledQuery,
-			},
-		);
+				alert: 'Lead_capture_email_regex_deprecation_alert',
+			});
+
+			await this.add(
+				'Livechat_lead_phone_regex',
+				'((?:\\([0-9]{1,3}\\)|[0-9]{2})[ \\-]*?[0-9]{4,5}(?:[\\-\\s\\_]{1,2})?[0-9]{4}(?:(?=[^0-9])|$)|[0-9]{4,5}(?:[\\-\\s\\_]{1,2})?[0-9]{4}(?:(?=[^0-9])|$))',
+				{
+					type: 'string',
+					group: 'Omnichannel',
+					section: 'CRM_Integration',
+					i18nLabel: 'Lead_capture_phone_regex',
+					enableQuery: omnichannelEnabledQuery,
+					alert: 'Lead_capture_phone_regex_deprecation_alert',
+				},
+			);
+		} else {
+			throw new Error('Omnichannel: Livechat lead capture features should be removed from the codebase in version 9.0.0');
+		}
 
 		await this.add('Livechat_history_monitor_type', 'url', {
 			type: 'select',

packages/i18n/src/locales/en.i18n.json

@@ -3075,7 +3075,9 @@
   "Layout_Sidenav_Footer_description": "Footer size is 260 x 70px",
   "Layout_Terms_of_Service": "Terms of Service",
   "Lead_capture_email_regex": "Lead capture email regex",
+  "Lead_capture_email_regex_deprecation_alert": "This feature is deprecated and will be removed in version 9.0.0.",
   "Lead_capture_phone_regex": "Lead capture phone regex",
+  "Lead_capture_phone_regex_deprecation_alert": "This feature is deprecated and will be removed in version 9.0.0.",
   "Leaders": "Leaders",
   "Learn_how_to_unlock_the_myriad_possibilities_of_rocket_chat": "Learn how to unlock the myriad possibilities of Rocket.Chat.",
   "Learn_more": "Learn more",
@@ -7161,4 +7163,4 @@
   "message_attachment": "message attachment",
   "system_message_body": "system message body",
   "No_changes_to_save": "No changes to save"
-}
+}

packages/models/src/models/LivechatVisitors.ts

@@ -369,6 +369,7 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 		return this.deleteOne({ _id });
 	}
 
+	// TODO: Remove Livechat lead capture features in version 9.0.0
 	saveGuestEmailPhoneById(_id: string, emails: string[], phones: string[]): Promise<UpdateResult | Document | void> {
 		const saveEmail = ([] as string[])
 			.concat(emails)