iatoolkit 0.63.1__py3-none-any.whl → 0.69.0__py3-none-any.whl

iatoolkit/services/sql_service.py

@@ -4,57 +4,87 @@
 # IAToolkit is open source software.
 
 from iatoolkit.repositories.database_manager import DatabaseManager
-
 from iatoolkit.common.util import Utility
+from iatoolkit.services.i18n_service import I18nService
+from iatoolkit.common.exceptions import IAToolkitException
 from sqlalchemy import text
-from injector import inject
+from injector import inject, singleton
 import json
-from iatoolkit.common.exceptions import IAToolkitException
+import logging
 
 
+@singleton
 class SqlService:
+    """
+    Manages database connections and executes SQL statements.
+    It maintains a cache of named DatabaseManager instances to avoid reconnecting.
+    """
+
     @inject
-    def __init__(self,util: Utility):
+    def __init__(self,
+                 util: Utility,
+                 i18n_service: I18nService):
         self.util = util
+        self.i18n_service = i18n_service
 
-    def exec_sql(self, db_manager: DatabaseManager, sql_statement: str) -> str:
+        # Cache for database connections
+        self._db_connections: dict[str, DatabaseManager] = {}
+
+    def register_database(self, db_name: str, db_uri: str):
+        """
+        Creates and caches a DatabaseManager instance for a given database name and URI.
+        If a database with the same name is already registered, it does nothing.
         """
-        Executes a raw SQL statement and returns the result as a JSON string.
+        if db_name in self._db_connections:
+            return
 
-        This method takes a DatabaseManager instance and a SQL query, executes it
-        against the database, and fetches all results. The results are converted
-        into a list of dictionaries, where each dictionary represents a row.
-        This list is then serialized to a JSON string.
-        If an exception occurs during execution, the transaction is rolled back,
-        and a custom IAToolkitException is raised.
+        logging.debug(f"Registering and creating connection for database: '{db_name}'")
+        db_manager = DatabaseManager(db_uri, register_pgvector=False)
+        self._db_connections[db_name] = db_manager
 
-        Args:
-            db_manager: The DatabaseManager instance to get the database session from.
-            sql_statement: The raw SQL statement to be executed.
+    def get_database_manager(self, db_name: str) -> DatabaseManager:
+        """
+        Retrieves a registered DatabaseManager instance from the cache.
+        """
+        try:
+            return self._db_connections[db_name]
+        except KeyError:
+            logging.error(f"Attempted to access unregistered database: '{db_name}'")
+            raise IAToolkitException(
+                IAToolkitException.ErrorType.DATABASE_ERROR,
+                f"Database '{db_name}' is not registered with the SqlService."
+            )
 
-        Returns:
-            A JSON string representing the list of rows returned by the query.
+    def exec_sql(self, db_name: str, sql_statement: str) -> str:
+        """
+        Executes a raw SQL statement against a registered database and returns the result as a JSON string.
         """
         try:
-            # here the SQL is executed
-            result = db_manager.get_session().execute(text(sql_statement))
+            # 1. Get the database manager from the cache
+            db_manager = self.get_database_manager(db_name)
 
-            # get the column names
+            # 2. Execute the SQL statement
+            result = db_manager.get_session().execute(text(sql_statement))
             cols = result.keys()
-
-            # convert rows to dict
             rows_context = [dict(zip(cols, row)) for row in result.fetchall()]
 
-            # Serialize to JSON with type convertion
+            # seialize the result
             sql_result_json = json.dumps(rows_context, default=self.util.serialize)
 
             return sql_result_json
+        except IAToolkitException:
+            # Re-raise exceptions from get_database_manager to preserve the specific error
+            raise
         except Exception as e:
-            db_manager.get_session().rollback()
+            # Attempt to rollback if a session was active
+            db_manager = self._db_connections.get(db_name)
+            if db_manager:
+                db_manager.get_session().rollback()
 
             error_message = str(e)
             if 'timed out' in str(e):
-                error_message = 'Intentalo de nuevo, se agoto el tiempo de espera'
+                error_message = self.i18n_service.t('errors.timeout')
 
+            logging.error(f"Error executing SQL statement: {error_message}")
             raise IAToolkitException(IAToolkitException.ErrorType.DATABASE_ERROR,
                                      error_message) from e

iatoolkit/services/user_feedback_service.py

@@ -6,8 +6,9 @@
 from iatoolkit.repositories.models import UserFeedback, Company
 from injector import inject
 from iatoolkit.repositories.profile_repo import ProfileRepo
+from iatoolkit.services.i18n_service import I18nService
 from iatoolkit.infra.google_chat_app import GoogleChatApp
-from iatoolkit.infra.mail_app import MailApp  # <-- 1. Importar MailApp
+from iatoolkit.infra.mail_app import MailApp
 import logging
 
 
@@ -15,9 +16,11 @@ class UserFeedbackService:
     @inject
     def __init__(self,
                  profile_repo: ProfileRepo,
+                 i18n_service: I18nService,
                  google_chat_app: GoogleChatApp,
                  mail_app: MailApp):
         self.profile_repo = profile_repo
+        self.i18n_service = i18n_service
         self.google_chat_app = google_chat_app
         self.mail_app = mail_app
 
@@ -31,9 +34,9 @@ class UserFeedbackService:
             }
             chat_result = self.google_chat_app.send_message(message_data=chat_data)
             if not chat_result.get('success'):
-                logging.warning(f"Error al enviar notificación a Google Chat: {chat_result.get('message')}")
+                logging.warning(f"error sending notification to Google Chat: {chat_result.get('message')}")
         except Exception as e:
-            logging.exception(f"Fallo inesperado al enviar notificación a Google Chat: {e}")
+            logging.exception(f"error sending notification to Google Chat: {e}")
 
     def _send_email_notification(self, destination_email: str, company_name: str, message_text: str):
         """Envía una notificación de feedback por correo electrónico."""
@@ -43,20 +46,20 @@ class UserFeedbackService:
             html_body = message_text.replace('\n', '<br>')
             self.mail_app.send_email(to=destination_email, subject=subject, body=html_body)
         except Exception as e:
-            logging.exception(f"Fallo inesperado al enviar email de feedback: {e}")
+            logging.exception(f"error sending email de feedback: {e}")
 
     def _handle_notification(self, company: Company, message_text: str):
         """Lee la configuración de la empresa y envía la notificación al canal correspondiente."""
         feedback_params = company.parameters.get('user_feedback')
         if not isinstance(feedback_params, dict):
-            logging.warning(f"No se encontró configuración de 'user_feedback' para la empresa {company.short_name}.")
+            logging.warning(f"missing 'user_feedback' configuration for company: {company.short_name}.")
             return
 
         # get channel and destination
         channel = feedback_params.get('channel')
         destination = feedback_params.get('destination')
         if not channel or not destination:
-            logging.warning(f"Configuración 'user_feedback' incompleta para {company.short_name}. Faltan 'channel' o 'destination'.")
+            logging.warning(f"invalid 'user_feedback' configuration for: {company.short_name}. Faltan 'channel' o 'destination'.")
             return
 
         if channel == 'google_chat':
@@ -64,7 +67,7 @@ class UserFeedbackService:
         elif channel == 'email':
             self._send_email_notification(destination_email=destination, company_name=company.short_name, message_text=message_text)
         else:
-            logging.warning(f"Canal de feedback '{channel}' no reconocido para la empresa {company.short_name}.")
+            logging.warning(f"unknown feedback channel: '{channel}' for company {company.short_name}.")
 
     def new_feedback(self,
                      company_short_name: str,
@@ -72,19 +75,18 @@ class UserFeedbackService:
                      user_identifier: str,
                      rating: int = None) -> dict:
         try:
-            # 1. Validar empresa
             company = self.profile_repo.get_company_by_short_name(company_short_name)
             if not company:
-                return {'error': f'No existe la empresa: {company_short_name}'}
+                return {'error': self.i18n_service.t('errors.company_not_found', company_short_name=company_short_name)}
 
-            # 2. Enviar notificación según la configuración de la empresa
+            # 2. send notification using company configuration
             notification_text = (f"*Nuevo feedback de {company_short_name}*:\n"
                                  f"*Usuario:* {user_identifier}\n"
                                  f"*Mensaje:* {message}\n"
                                  f"*Calificación:* {rating if rating is not None else 'N/A'}")
             self._handle_notification(company, notification_text)
 
-            # 3. Guardar el feedback en la base de datos (independientemente del éxito de la notificación)
+            # 3. always save the feedback in the database
             new_feedback_obj = UserFeedback(
                 company_id=company.id,
                 message=message,
@@ -93,10 +95,10 @@ class UserFeedbackService:
             )
             saved_feedback = self.profile_repo.save_feedback(new_feedback_obj)
             if not saved_feedback:
-                logging.error(f"No se pudo guardar el feedback para el usuario {user_identifier} en la empresa {company_short_name}")
-                return {'error': 'No se pudo guardar el feedback'}
+                logging.error(f"can't save feedback for user {user_identifier}/{company_short_name}")
+                return {'error': 'can not save the feedback'}
 
-            return {'message': 'Feedback guardado correctamente'}
+            return {'success': True, 'message': 'Feedback guardado correctamente'}
 
         except Exception as e:
             logging.exception(f"Error crítico en el servicio de feedback: {e}")

iatoolkit/static/js/chat_feedback_button.js

@@ -1,110 +1,80 @@
 $(document).ready(function () {
+    const feedbackModal = $('#feedbackModal');
+    $('#submit-feedback').on('click', function () {
+        sendFeedback(this);
+    });
 
     // Evento para enviar el feedback
-    $('#submit-feedback').on('click', async function() {
+    async function sendFeedback(submitButton) {
+        toastr.options = {"positionClass": "toast-bottom-right", "preventDuplicates": true};
         const feedbackText = $('#feedback-text').val().trim();
-        const submitButton = $(this);
-
-        // --- LÓGICA DE COMPATIBILIDAD BS3 / BS5 ---
-        // Detecta si Bootstrap 5 está presente.
-        const isBootstrap5 = (typeof bootstrap !== 'undefined');
-
-        // Define el HTML del botón de cierre según la versión.
-        const closeButtonHtml = isBootstrap5 ?
-            '<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>' : // Versión BS5
-            '<button type="button" class="close" data-dismiss="alert"><span>&times;</span></button>';     // Versión BS3/BS4
-        // --- FIN DE LA LÓGICA DE COMPATIBILIDAD ---
+        const activeStars = $('.star.active').length;
 
         if (!feedbackText) {
-            const alertHtml = `
-            <div class="alert alert-warning alert-dismissible fade show" role="alert">
-                <strong>¡Atención!</strong> Por favor, escribe tu comentario antes de enviar.
-                ${closeButtonHtml}
-            </div>`;
-            $('.modal-body .alert').remove();
-            $('.modal-body').prepend(alertHtml);
+            toastr.error(t_js('feedback_comment_error'));
             return;
         }
 
-        const activeStars = $('.star.active').length;
         if (activeStars === 0) {
-            const alertHtml = `
-            <div class="alert alert-warning alert-dismissible fade show" role="alert">
-                <strong>¡Atención!</strong> Por favor, califica al asistente con las estrellas.
-                ${closeButtonHtml}
-            </div>`;
-            $('.modal-body .alert').remove();
-            $('.modal-body').prepend(alertHtml);
+            toastr.error(t_js('feedback_rating_error'));
             return;
         }
 
-        submitButton.prop('disabled', true);
-        submitButton.html('<i class="bi bi-send me-1 icon-spaced"></i>Enviando...');
+        submitButton.disabled = true;
 
-        const response = await sendFeedback(feedbackText);
-        $('#feedbackModal').modal('hide');
-        if (response)
-            toastr.success('¡Gracias por tu comentario!', 'Feedback Enviado');
+        // call the IAToolkit API to send feedback
+        const data = {
+            "user_identifier": window.user_identifier,
+            "message": feedbackText,
+            "rating": activeStars,
+        };
+
+        const responseData = await callToolkit('/api/feedback', data, "POST");
+        if (responseData)
+            toastr.success(t_js('feedback_sent_success_body'), t_js('feedback_sent_success_title'));
         else
-            toastr.error('No se pudo enviar el feedback, por favor intente nuevamente.', 'Error');
-    });
+            toastr.error(t_js('feedback_sent_error'));
 
-    // Evento para abrir el modal de feedback
-    $('#send-feedback-button').on('click', function() {
-        $('#submit-feedback').prop('disabled', false);
-        $('#submit-feedback').html('<i class="bi bi-send me-1 icon-spaced"></i>Enviar');
-        $('.star').removeClass('active hover-active'); // Resetea estrellas
-        $('#feedback-text').val(''); // Limpia texto
-        $('.modal-body .alert').remove(); // Quita alertas previas
-        $('#feedbackModal').modal('show');
-    });
+        submitButton.disabled = false;
+        feedbackModal.modal('hide');
+    }
 
-    // Evento que se dispara DESPUÉS de que el modal se ha ocultado
-    $('#feedbackModal').on('hidden.bs.modal', function () {
-        $('#feedback-text').val('');
-        $('.modal-body .alert').remove();
-        $('.star').removeClass('active');
+// Evento para abrir el modal de feedback
+$('#send-feedback-button').on('click', function () {
+    $('#submit-feedback').prop('disabled', false);
+    $('.star').removeClass('active hover-active'); // Resetea estrellas
+    $('#feedback-text').val('');
+    feedbackModal.modal('show');
+});
+
+// Evento que se dispara DESPUÉS de que el modal se ha ocultado
+$('#feedbackModal').on('hidden.bs.modal', function () {
+    $('#feedback-text').val('');
+    $('.star').removeClass('active');
+});
+
+// Function for the star rating system
+window.gfg = function (rating) {
+    $('.star').removeClass('active');
+    $('.star').each(function (index) {
+        if (index < rating) {
+            $(this).addClass('active');
+        }
     });
+};
 
-    // Función para el sistema de estrellas
-    window.gfg = function(rating) {
-        $('.star').removeClass('active');
-        $('.star').each(function(index) {
-            if (index < rating) {
-                $(this).addClass('active');
+$('.star').hover(
+    function () {
+        const rating = $(this).data('rating');
+        $('.star').removeClass('hover-active');
+        $('.star').each(function (index) {
+            if ($(this).data('rating') <= rating) {
+                $(this).addClass('hover-active');
             }
         });
-    };
+    },
+    function () {
+        $('.star').removeClass('hover-active');
+    });
 
-    $('.star').hover(
-        function() {
-            const rating = $(this).data('rating');
-            $('.star').removeClass('hover-active');
-            $('.star').each(function(index) {
-                if ($(this).data('rating') <= rating) {
-                    $(this).addClass('hover-active');
-                }
-            });
-        },
-        function() {
-            $('.star').removeClass('hover-active');
-        }
-    );
 });
-
-const sendFeedback = async function(message) {
-    const activeStars = $('.star.active').length;
-    const data = {
-        "user_identifier": window.user_identifier,
-        "message": message,
-        "rating": activeStars,
-    };
-    try {
-        // Asumiendo que callLLMAPI está definido globalmente en otro archivo (ej. chat_main.js)
-        const responseData = await callToolkit('/api/feedback', data, "POST");
-        return responseData;
-    } catch (error) {
-        console.error("Error al enviar feedback:", error);
-        return null;
-    }
-}

iatoolkit/static/js/chat_help_content.js

@@ -0,0 +1,124 @@
+$(document).ready(function () {
+
+    let helpContent = null; // Variable para cachear el contenido de ayuda
+
+    // Evento de clic en el botón de ayuda
+    $('#open-help-button').on('click', async function () {
+        const helpModal = new bootstrap.Modal(document.getElementById('helpModal'));
+        const accordionContainer = $('#help-accordion-container');
+        const spinner = $('#help-spinner');
+
+        // Si el contenido no se ha cargado, hacer la llamada a la API
+        if (helpContent) {
+            // Si el contenido ya está cacheado, solo muestra el modal
+            helpModal.show();
+            return;
+        }
+
+        spinner.show();
+        accordionContainer.hide();
+        helpModal.show();
+
+        try {
+            const helpContent = await callToolkit('/api/help-content', {}, "POST");
+
+            if (!helpContent) {
+                toastr.error('No se pudo cargar la guía de uso. Por favor, intente más tarde.');
+                spinner.hide();
+                helpModal.hide();
+                return;
+            }
+
+            // Construir el HTML del acordeón y mostrarlo
+            buildHelpAccordion(helpContent);
+            spinner.hide();
+            accordionContainer.show();
+
+        } catch (error) {
+            console.error("Error al cargar el contenido de ayuda:", error);
+            toastr.error('Ocurrió un error de red al cargar la guía.');
+            spinner.hide();
+            helpModal.hide();
+        }
+    });
+
+    /**
+     * Construye dinámicamente el HTML para el acordeón de ayuda a partir de los datos.
+     * @param {object} data El objeto JSON con el contenido de ayuda.
+     */
+    function buildHelpAccordion(data) {
+        const container = $('#help-accordion-container');
+        container.empty(); // Limpiar cualquier contenido previo
+
+        let accordionHtml = '';
+
+        if (data.example_questions) {
+            let contentHtml = '';
+            data.example_questions.forEach(cat => {
+                contentHtml += `<h6 class="fw-bold">${cat.category}</h6><ul>`;
+                cat.questions.forEach(q => contentHtml += `<li>${q}</li>`);
+                contentHtml += `</ul>`;
+            });
+            accordionHtml += createAccordionItem('examples', 'Preguntas de Ejemplo', contentHtml, true);
+        }
+
+        if (data.data_sources) {
+            let contentHtml = '<dl>';
+            data.data_sources.forEach(p => {
+                contentHtml += `<dt>${p.source}</dt><dd>${p.description}</dd>`;
+            });
+            contentHtml += `</dl>`;
+            accordionHtml += createAccordionItem('sources', 'Datos disponibles', contentHtml );
+        }
+
+        if (data.best_practices) {
+            let contentHtml = '<dl>';
+            data.best_practices.forEach(p => {
+                contentHtml += `<dt>${p.title}</dt><dd>${p.description}`;
+                if (p.example) {
+                    contentHtml += `<br><small class="text-muted"><em>Ej: "${p.example}"</em></small>`;
+                }
+                contentHtml += `</dd>`;
+            });
+            contentHtml += `</dl>`;
+            accordionHtml += createAccordionItem('practices', 'Mejores Prácticas', contentHtml);
+        }
+
+        if (data.capabilities) {
+            let contentHtml = `<div class="row">`;
+            contentHtml += `<div class="col-md-6"><h6 class="fw-bold">Puede hacer:</h6><ul>${data.capabilities.can_do.map(item => `<li>${item}</li>`).join('')}</ul></div>`;
+            contentHtml += `<div class="col-md-6"><h6 class="fw-bold">No puede hacer:</h6><ul>${data.capabilities.cannot_do.map(item => `<li>${item}</li>`).join('')}</ul></div>`;
+            contentHtml += `</div>`;
+            accordionHtml += createAccordionItem('capabilities', 'Capacidades y Límites', contentHtml);
+        }
+
+        container.html(accordionHtml);
+    }
+
+    /**
+     * Helper para crear un item del acordeón de Bootstrap.
+     * @param {string} id El ID base para los elementos.
+     * @param {string} title El título que se muestra en el botón del acordeón.
+     * @param {string} contentHtml El HTML que va dentro del cuerpo colapsable.
+     * @param {boolean} isOpen Si el item debe estar abierto por defecto.
+     * @returns {string} El string HTML del item del acordeón.
+     */
+    function createAccordionItem(id, title, contentHtml, isOpen = false) {
+        const showClass = isOpen ? 'show' : '';
+        const collapsedClass = isOpen ? '' : 'collapsed';
+
+        return `
+            <div class="accordion-item">
+                <h2 class="accordion-header" id="heading-${id}">
+                    <button class="accordion-button ${collapsedClass}" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-${id}" aria-expanded="${isOpen}" aria-controls="collapse-${id}">
+                        ${title}
+                    </button>
+                </h2>
+                <div id="collapse-${id}" class="accordion-collapse collapse ${showClass}" aria-labelledby="heading-${id}" data-bs-parent="#help-accordion-container">
+                    <div class="accordion-body">
+                        ${contentHtml}
+                    </div>
+                </div>
+            </div>`;
+    }
+});