diff --git a/api/package-lock.json b/api/package-lock.json index 944e4d497..2284efe60 100644 --- a/api/package-lock.json +++ b/api/package-lock.json @@ -35,6 +35,7 @@ "dotenv": "^16.3.1", "ejs": "^3.1.9", "express-session": "^1.17.3", + "handlebars": "^4.7.8", "module-alias": "^2.2.3", "mongoose": "^8.0.0", "mongoose-lean-defaults": "^2.2.1", @@ -11461,7 +11462,6 @@ "version": "4.7.8", "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz", "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==", - "devOptional": true, "dependencies": { "minimist": "^1.2.5", "neo-async": "^2.6.2", @@ -11482,7 +11482,6 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "devOptional": true, "engines": { "node": ">=0.10.0" } @@ -15296,8 +15295,7 @@ "node_modules/neo-async": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "devOptional": true + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==" }, "node_modules/nest-commander": { "version": "3.15.0", @@ -19313,7 +19311,6 @@ "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", "integrity": "sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==", - "dev": true, "optional": true, "bin": { "uglifyjs": "bin/uglifyjs" @@ -20048,8 +20045,7 @@ "node_modules/wordwrap": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", - "devOptional": true + "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==" }, "node_modules/wrap-ansi": { "version": "6.2.0", diff --git a/api/package.json b/api/package.json index 825ffa3cc..70e5d59a8 100644 --- a/api/package.json +++ b/api/package.json @@ -70,6 +70,7 @@ "dotenv": "^16.3.1", "ejs": "^3.1.9", "express-session": "^1.17.3", + "handlebars": "^4.7.8", "module-alias": "^2.2.3", "mongoose": "^8.0.0", "mongoose-lean-defaults": "^2.2.1", diff --git a/api/src/chat/services/block.service.spec.ts b/api/src/chat/services/block.service.spec.ts index fb4ad88f6..7d8f80e62 100644 --- a/api/src/chat/services/block.service.spec.ts +++ b/api/src/chat/services/block.service.spec.ts @@ -559,7 +559,7 @@ describe('BlockService', () => { it('should process text replacements with ontext vars', () => { const result = blockService.processText( - '{context.user.first_name} {context.user.last_name}, email : {context.vars.email}', + '{{context.user.first_name}} {{context.user.last_name}}, email : {{context.vars.email}}', contextEmailVarInstance, subscriberContext, settings, @@ -569,7 +569,7 @@ describe('BlockService', () => { it('should process text replacements with context vars', () => { const result = blockService.processText( - '{context.user.first_name} {context.user.last_name}, phone : {context.vars.phone}', + '{{context.user.first_name}} {{context.user.last_name}}, phone : {{context.vars.phone}}', contextEmailVarInstance, subscriberContext, settings, @@ -579,7 +579,7 @@ describe('BlockService', () => { it('should process text replacements with settings contact infos', () => { const result = blockService.processText( - 'Trying the settings : the name of company is <<{contact.company_name}>>', + 'Trying the settings : the name of company is <<{{contact.company_name}}>>', contextBlankInstance, subscriberContext, settings, diff --git a/api/src/chat/services/block.service.ts b/api/src/chat/services/block.service.ts index 04028bc88..af2c6a313 100644 --- a/api/src/chat/services/block.service.ts +++ b/api/src/chat/services/block.service.ts @@ -8,6 +8,7 @@ import { Injectable } from '@nestjs/common'; import { OnEvent } from '@nestjs/event-emitter'; +import Handlebars from 'handlebars'; import { AttachmentService } from '@/attachment/services/attachment.service'; import EventWrapper from '@/channel/lib/EventWrapper'; @@ -389,57 +390,71 @@ export class BlockService extends BaseService< subscriberContext: SubscriberContext, settings: Settings, ): string { - const vars = { ...(subscriberContext?.vars || {}), ...context.vars }; - // Replace context tokens with their values - Object.keys(vars).forEach((key) => { - if (typeof vars[key] === 'string' && vars[key].indexOf(':') !== -1) { - const tmp = vars[key].split(':'); - vars[key] = tmp[1]; + const mergedVars = { ...(subscriberContext?.vars || {}), ...context.vars }; + + // Process each var: + // - If a string contains a colon, take the substring after the colon. + // - If the value is not a string, JSON.stringify it. + const processedVars: { [key: string]: string } = {}; + Object.keys(mergedVars).forEach((key) => { + let value = mergedVars[key]; + if (typeof value === 'string' && value.indexOf(':') !== -1) { + const parts = value.split(':'); + value = parts[1]; } - text = text.replace( - '{context.vars.' + key + '}', - typeof vars[key] === 'string' ? vars[key] : JSON.stringify(vars[key]), - ); + if (typeof value !== 'string') { + value = JSON.stringify(value); + } + processedVars[key] = value; }); - // Replace context tokens about user location + // Process user_location if present + const processedUserLocation: any = {}; if (context.user_location) { + processedUserLocation.lat = context.user_location.lat.toString(); + processedUserLocation.lon = context.user_location.lon.toString(); + if (context.user_location.address) { - const userAddress = context.user_location.address; - Object.keys(userAddress).forEach((key) => { - text = text.replace( - '{context.user_location.address.' + key + '}', - typeof userAddress[key] === 'string' - ? userAddress[key] - : JSON.stringify(userAddress[key]), - ); + const processedAddress: { [key: string]: string } = {}; + Object.keys(context.user_location.address).forEach((key) => { + let value = context.user_location.address![key]; + if (typeof value !== 'string') { + value = JSON.stringify(value); + } + processedAddress[key] = value; }); + processedUserLocation.address = processedAddress; } - text = text.replace( - '{context.user_location.lat}', - context.user_location.lat.toString(), - ); - text = text.replace( - '{context.user_location.lon}', - context.user_location.lon.toString(), - ); } - // Replace tokens for user infos - Object.keys(context.user).forEach((key) => { - const userAttr = (context.user as any)[key]; - text = text.replace( - '{context.user.' + key + '}', - typeof userAttr === 'string' ? userAttr : JSON.stringify(userAttr), - ); - }); - - // Replace contact infos tokens with their values - Object.keys(settings.contact).forEach((key) => { - text = text.replace('{contact.' + key + '}', settings.contact[key]); - }); + // Process user info tokens + const processedUser: { [key: string]: string } = {}; + if (context.user) { + Object.keys(context.user).forEach((key) => { + let value = context.user![key]; + if (typeof value !== 'string') { + value = JSON.stringify(value); + } + processedUser[key] = value; + }); + } - return text; + // Process contact tokens from settings (assumed to be strings) + const processedContact = { ...settings.contact }; + + // Build the template context for Handlebars to match our token paths + const templateContext = { + context: { + vars: processedVars, + user_location: processedUserLocation, + user: processedUser, + }, + contact: processedContact, + }; + + // Compile and run the Handlebars template + const compiledTemplate = Handlebars.compile(text); + return compiledTemplate(templateContext); } /** diff --git a/api/src/migration/migrations/1741871431277-v-2-3-0.migration.ts b/api/src/migration/migrations/1741871431277-v-2-3-0.migration.ts new file mode 100644 index 000000000..fd2c7670e --- /dev/null +++ b/api/src/migration/migrations/1741871431277-v-2-3-0.migration.ts @@ -0,0 +1,225 @@ +/* + * Copyright © 2025 Hexastack. All rights reserved. + * + * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms: + * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission. + * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file). + */ + +import mongoose, { AnyBulkWriteOperation } from 'mongoose'; + +import blockSchema, { Block } from '@/chat/schemas/block.schema'; +import translationSchema, { + Translation, +} from '@/i18n/schemas/translation.schema'; + +import { MigrationAction, MigrationServices } from '../types'; + +const updateContextVarsHandleBarsSyntaxe = async ( + action: MigrationAction, + { logger }: MigrationServices, +) => { + const LOG_MESSAGES = { + up: { + success: 'Successfully updated blocks to use handleBars syntaxe.', + noUpdates: 'No blocks were updated to use handleBars syntaxe.', + exception: 'Unable to update blocks to use handleBars syntaxe.', + }, + down: { + success: 'Successfully rollbacked handleBars syntaxe.', + noUpdates: 'No blocks were rollbacked to not use handleBars syntxae.', + exception: 'Unable blocks to rollback handleBars syntaxe.', + }, + }; + const BlockModel = mongoose.model(Block.name, blockSchema); + + // Define the regex patterns based on UP or DOWN + const bracesRegex = + action === MigrationAction.UP + ? /\{(context\.[^}]+)\}/g + : /\{\{(context\.[^}]+)\}\}/g; + + const replacement = action === MigrationAction.UP ? '{{$1}}' : '{$1}'; + + // Function to update braces based on the direction + function updateBraces(text: string) { + return text.replace(bracesRegex, replacement); + } + + // Try to replace braces for all attributes of type string or string[] + function updateStringsInObject(obj: any): any { + if (typeof obj === 'string') { + return updateBraces(obj); + } + + if (Array.isArray(obj)) { + return obj.map((item) => + typeof item === 'string' ? updateBraces(item) : item, + ); + } + + if (typeof obj === 'object' && obj !== null) { + for (const key of Object.keys(obj)) { + obj[key] = updateStringsInObject(obj[key]); + } + } + + return obj; + } + try { + const blocks = await BlockModel.find({}, {}, { lean: true }); + const bulkOps: AnyBulkWriteOperation[] = []; + + blocks.forEach((doc) => { + let updated = false; + + // Update options.fallback.message if it exists + if (doc.options?.fallback?.message) { + const updatedMessages = doc.options.fallback.message.map((msg) => + updateBraces(msg), + ); + doc.options.fallback.message = updatedMessages; + updated = true; + } + if (doc.message && typeof doc.message === 'object') { + const updatedMessage = updateStringsInObject(doc.message); + doc.message = updatedMessage; + updated = true; + } + + if (updated) { + bulkOps.push({ + updateOne: { + filter: { _id: doc._id }, + update: { + $set: { options: doc.options, message: doc.message }, + }, + }, + }); + } + }); + + // Perform a bulk update + if (bulkOps.length > 0) { + const result = await BlockModel.bulkWrite(bulkOps); + if (result.matchedCount > 0) { + logger.log(LOG_MESSAGES[action].success); + return true; + } + } else { + logger.log(LOG_MESSAGES[action].noUpdates); + return true; + } + } catch (err) { + logger.error(LOG_MESSAGES[action].exception, err); + throw new Error(LOG_MESSAGES[action].exception); + } +}; + +const updateContextVarsHandleBarsSyntaxInTranslation = async ( + action: MigrationAction, + { logger }: MigrationServices, +) => { + const LOG_MESSAGES = { + up: { + success: 'Successfully updated translations to use handleBars syntax.', + noUpdates: 'No translations were updated to use handleBars syntax.', + exception: 'Unable to update translations to use handleBars syntax.', + }, + down: { + success: 'Successfully rollbacked handleBars syntax in translations.', + noUpdates: + 'No translations were rollbacked to not use handleBars syntax.', + exception: 'Unable to rollback handleBars syntax in translations.', + }, + }; + + // Define the regex patterns based on UP or DOWN + const bracesRegex = + action === MigrationAction.UP + ? /\{(context\.[^}]+)\}/g + : /\{\{(context\.[^}]+)\}\}/g; + + const replacement = action === MigrationAction.UP ? '{{$1}}' : '{$1}'; + + // Function to update braces based on the direction + function updateBraces(text: string) { + return text.replace(bracesRegex, replacement); + } + + try { + const TranslationModel = mongoose.model( + Translation.name, + translationSchema, + ); // Use the correct model for translations + const translations = await TranslationModel.find({}, {}, { lean: true }); + + const bulkOps: AnyBulkWriteOperation[] = []; + + translations.forEach((doc) => { + let updated = false; + + // Update the "str" field if it exists + if (doc.str) { + const updatedStr = updateBraces(doc.str); + doc.str = updatedStr; + updated = true; + } + + // Update translations if they exist + if (doc.translations && typeof doc.translations === 'object') { + for (const lang in doc.translations) { + if (doc.translations[lang]) { + const updatedTranslation = updateBraces(doc.translations[lang]); + doc.translations[lang] = updatedTranslation; + updated = true; + } + } + } + + // If any field was updated, prepare the bulk operation + if (updated) { + bulkOps.push({ + updateOne: { + filter: { _id: doc._id }, + update: { $set: { str: doc.str, translations: doc.translations } }, + }, + }); + } + }); + + // Perform the bulk update if there are operations + if (bulkOps.length > 0) { + const result = await TranslationModel.bulkWrite(bulkOps); + if (result.matchedCount > 0) { + logger.log(LOG_MESSAGES[action].success); + return true; + } + } else { + logger.log(LOG_MESSAGES[action].noUpdates); + return true; + } + } catch (err) { + logger.error(LOG_MESSAGES[action].exception, err); + throw new Error(LOG_MESSAGES[action].exception); + } +}; + +module.exports = { + async up(services: MigrationServices) { + await updateContextVarsHandleBarsSyntaxe(MigrationAction.UP, services); + await updateContextVarsHandleBarsSyntaxInTranslation( + MigrationAction.UP, + services, + ); + return true; + }, + async down(services: MigrationServices) { + await updateContextVarsHandleBarsSyntaxe(MigrationAction.DOWN, services); + await updateContextVarsHandleBarsSyntaxInTranslation( + MigrationAction.DOWN, + services, + ); + return true; + }, +}; diff --git a/frontend/src/components/visual-editor/form/inputs/ReplacementTokens.tsx b/frontend/src/components/visual-editor/form/inputs/ReplacementTokens.tsx index e1bbfd95a..c1a15ad8f 100644 --- a/frontend/src/components/visual-editor/form/inputs/ReplacementTokens.tsx +++ b/frontend/src/components/visual-editor/form/inputs/ReplacementTokens.tsx @@ -1,5 +1,5 @@ /* - * Copyright © 2024 Hexastack. All rights reserved. + * Copyright © 2025 Hexastack. All rights reserved. * * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms: * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission. @@ -65,7 +65,7 @@ function ReplacementTokens() { {(contextVars || []).map((v, index) => ( @@ -76,7 +76,7 @@ function ReplacementTokens() { {userInfos.map((v, index) => ( @@ -87,7 +87,7 @@ function ReplacementTokens() { {userLocation.map((v, index) => ( @@ -100,7 +100,7 @@ function ReplacementTokens() { {(contactInfos || []).map((v, index) => (