Integra Mellowtel en tu aplicación Electron

​

Requisitos previos

• Una cuenta de Mellowtel y clave de configuración (obtén la tuya desde el panel de control).
• Una aplicación Electron con acceso al proceso principal.

​

Instalación

​

1. Instala el paquete

npm install mellowtel-electron

​

2. Añádelo a tu código

import { app, BrowserWindow } from 'electron';
import Mellowtel, { setupMellowtelApp } from 'mellowtel-electron';

// Opcional: Llama ANTES de app.ready para prevenir diálogos del sistema
setupMellowtelApp();

// Cuando la aplicación esté lista, crea la ventana
app.whenReady().then(async () => {
  let win = createWindow();

  const mellowtel: Mellowtel = new Mellowtel('YOUR_CONFIGURATION_KEY');

  await mellowtel.requestConsent(win, "Obtén 3 meses gratis")
  await mellowtel.init()
});

• new Mellowtel(configurationKey, options?) instancia el SDK. La única opción disponible hoy es disableLogs, que por defecto es true. Establécelo en false mientras integras para que puedas ver el estado de la conexión y la actividad de las solicitudes en tu terminal.
• requestConsent(window, incentive) renderiza un cuadro de mensaje nativo de Electron anclado a la BrowserWindow que pasas. El segundo argumento es el titular destacado del diálogo (por ejemplo, "Obtén 3 meses gratis"), mostrado sobre una explicación fija de lo que hace Mellowtel. Se resuelve en true si el usuario acepta, false si el usuario rechaza o cierra el diálogo, y undefined si el consentimiento ya está registrado. El SDK persiste la decisión de optar automáticamente, por lo que no necesitas llamar a optIn() después.
• init() lanza solo cuando configurationKey está vacío. Si el usuario no ha optado por participar, registra y retorna silenciosamente. De lo contrario, abre un WebSocket al backend de Mellowtel. La llamada no bloquea la interfaz de usuario del renderizador, por lo que las ventanas permanecen receptivas mientras se establece la conexión.

​

Prevención de interrupciones de diálogos del sistema (recomendado)

​

Consentimiento del usuario

1. Usa el diálogo nativo incorporado a través de requestConsent(window, incentive). Este es el camino más rápido y es lo que muestra el fragmento anterior. Renderiza un dialog.showMessageBox nativo de Electron con tu copia de incentivo como el titular y persiste automáticamente la decisión del usuario.
2. Construye tu propia interfaz de consentimiento y maneja el SDK a través de optIn(), optOut(), y getOptInStatus(). Usa esto si deseas personalización de marca, explicaciones más ricas o localización más allá de lo que ofrece el diálogo nativo.

​

Qué debe incluir tu diálogo de consentimiento

​

Permitir que los usuarios cambien su consentimiento más tarde

​

Referencia de métodos

• init(): Promise<void> inicia el servicio si el usuario ha optado por participar, o retorna silenciosamente temprano si no. Lanza solo cuando la clave de configuración está vacía.
• shutdown(): Promise<void> limpia los recursos del SDK cuando la aplicación se está cerrando. Cierra el WebSocket, destruye ventanas de trabajo ocultas y limpia temporizadores en segundo plano. Preserva la preferencia de opt-in del usuario.
• requestConsent(window: BrowserWindow, incentive: string): Promise<boolean | undefined> muestra el diálogo de consentimiento nativo incorporado y persiste el resultado. Retorna true al aceptar, false al rechazar o cerrar, undefined si el consentimiento ya fue dado.
• showConsentSettings(window: BrowserWindow): Promise<void> muestra el diálogo de gestión de consentimiento incorporado. El SDK maneja las transiciones de opt-in / opt-out internamente cuando el usuario cambia su elección.

• optIn(): Promise<void> marca al usuario como optado sin mostrar un diálogo. Usa esto solo después de recopilar el consentimiento a través de tu propia interfaz.
• optOut(): Promise<void> marca al usuario como no optado y realiza una limpieza completa (los mismos recursos que shutdown(), además de borrar la preferencia de consentimiento guardada). No es necesario llamar a shutdown() después.
• getOptInStatus(): boolean | undefined retorna el estado actual de opt-in, o undefined si el usuario nunca ha tomado una decisión.
• getNodeId(): string retorna el identificador de nodo de Mellowtel para esta instalación. Útil al presentar tickets de soporte.

• getTotalRequestCount(): number retorna el total de solicitudes procesadas desde la instalación.
• getDailyRequestCount(): number retorna el número de solicitudes procesadas hoy.
• getRequestCountForDate(date: string): number retorna el conteo para una fecha específica YYYY-MM-DD.
• getDailyRequestsHistory(): { [date: string]: number } retorna cada conteo diario como un mapa.
• getRequestCountsInRange(startDate: string, endDate: string): { [date: string]: number } retorna conteos para un rango de fechas.
• getRequestCounts(): { total: number; daily: number; dailyHistory: { [date: string]: number } } retorna los tres contadores en una sola llamada.

​

Ciclo de vida y cierre de la aplicación

• Cierra la conexión WebSocket.
• Destruye las ventanas de trabajo ocultas.
• Limpia temporizadores en segundo plano y recursos de red.
• Preserva la preferencia de opt-in del usuario.

​

Aplicaciones de una sola ventana

mainWindow.on('closed', async () => {
  mainWindow = null;

  if (process.platform !== 'darwin') {
    await mellowtel.shutdown();
    app.quit();
  }
});

​

Aplicaciones de bandeja

trayQuitItem.click = async () => {
  await mellowtel.shutdown();
  app.quit();
};

​

Aplicaciones de macOS

​

Optando por no participar

await mellowtel.optOut();

​

Iniciando de nuevo

await mellowtel.optIn(); // Solo necesario después de optOut()
await mellowtel.init();

​

Persistencia del consentimiento

• macOS: ~/Library/Application Support/<YourAppName>/config.json
• Windows: %APPDATA%\<YourAppName>\config.json
• Linux: ~/.config/<YourAppName>/config.json

​

Solución de problemas