Guide d’Intégration et de Consentement pour le SDK Electron de Mellowtel

​

Prérequis

• Un compte Mellowtel et une clé de configuration (obtiens la tienne depuis le tableau de bord).
• Une application Electron avec accès au processus principal.

​

Installation

​

1. Configurer l’authentification npm

@mellowtel-inc:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=YOUR_NPM_TOKEN

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

​

2. Installer le package

npm install @mellowtel-inc/mellowtel-electron

​

3. Ajouter à ton code

import { app, BrowserWindow } from 'electron';
import Mellowtel from '@mellowtel-inc/mellowtel-electron';


// Quand l'application est prête, crée la fenêtre
app.whenReady().then(async () => {
  let win = createWindow();
  
  const mellowtel: Mellowtel = new Mellowtel('YOUR_CONFIGURATION_KEY');

  await mellowtel.requestConsent(win, "Obtenez 3 mois gratuits")
  await mellowtel.init()
});

• new Mellowtel(configurationKey, options?) instancie le SDK. La seule option disponible aujourd’hui est disableLogs, qui est par défaut à true. Mets-le à false pendant l’intégration pour voir l’état de la connexion et l’activité des requêtes dans ton terminal.
• requestConsent(window, incentive) rend une boîte de message native Electron ancrée à la BrowserWindow que tu passes. Le deuxième argument est le titre principal du dialogue (par exemple, "Obtenez 3 mois gratuits"), affiché au-dessus d’une explication fixe de ce que fait Mellowtel. Cela se résout à true si l’utilisateur accepte, false si l’utilisateur refuse ou ferme le dialogue, et undefined si le consentement est déjà enregistré. Le SDK persiste automatiquement la décision d’opt-in, donc tu n’as pas besoin d’appeler optIn() ensuite.
• init() ne génère une erreur que lorsque configurationKey est vide. Si l’utilisateur n’a pas opté, il enregistre et retourne silencieusement. Sinon, il ouvre un WebSocket vers le backend de Mellowtel. L’appel n’est pas bloquant pour l’interface utilisateur du renderer, donc les fenêtres restent réactives pendant que la connexion est établie.

​

Prévenir les interruptions de dialogue système (recommandé)

​

Consentement de l’utilisateur

1. Utiliser le dialogue natif intégré via requestConsent(window, incentive). C’est le chemin le plus rapide et ce que montre l’extrait ci-dessus. Il rend un dialog.showMessageBox natif Electron avec ton texte d’incitation comme titre et persiste automatiquement la décision de l’utilisateur.
2. Construire ta propre interface de consentement et piloter le SDK via optIn(), optOut(), et getOptInStatus(). Utilise cela si tu veux un branding personnalisé, des explications plus riches, ou une localisation au-delà de ce que le dialogue natif offre.

​

Ce que ton dialogue de consentement doit inclure

​

Permettre aux utilisateurs de changer leur consentement plus tard

​

Référence des méthodes

• init(): Promise<void> démarre le service si l’utilisateur a opté, ou retourne silencieusement tôt sinon. Génère une erreur uniquement lorsque la clé de configuration est vide.
• requestConsent(window: BrowserWindow, incentive: string): Promise<boolean | undefined> affiche le dialogue de consentement natif intégré et persiste le résultat. Retourne true en cas d’acceptation, false en cas de refus ou de fermeture, undefined si le consentement a déjà été donné.
• showConsentSettings(window: BrowserWindow): Promise<void> affiche le dialogue de gestion du consentement intégré. Le SDK gère les transitions d’opt-in / opt-out en interne lorsque l’utilisateur bascule son choix.

• optIn(): Promise<void> marque l’utilisateur comme ayant opté sans afficher de dialogue. Utilise ceci uniquement après avoir collecté le consentement via ton propre UI.
• optOut(): Promise<void> marque l’utilisateur comme ayant opté et ferme la connexion WebSocket active.
• getOptInStatus(): boolean | undefined retourne l’état actuel de l’opt-in, ou undefined si l’utilisateur n’a jamais fait de choix.
• getNodeId(): string retourne l’identifiant de nœud Mellowtel pour cette installation. Utile lors du dépôt de tickets de support.

• getTotalRequestCount(): number retourne le total des requêtes traitées depuis l’installation.
• getDailyRequestCount(): number retourne le nombre de requêtes traitées aujourd’hui.
• getRequestCountForDate(date: string): number retourne le compte pour une date spécifique YYYY-MM-DD.
• getDailyRequestsHistory(): { [date: string]: number } retourne chaque compte quotidien sous forme de carte.
• getRequestCountsInRange(startDate: string, endDate: string): { [date: string]: number } retourne les comptes pour une plage de dates.
• getRequestCounts(): { total: number; daily: number; dailyHistory: { [date: string]: number } } retourne les trois compteurs en un seul appel.

​

Arrêt et Cycle de Vie

​

Persistance du Consentement

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

​

Dépannage