Hooks

/**
 * Cette fonction est appelée quand une note est stockée dans le disque
 * Vous ne pouvez pas modifier les notes stockées, ce serait le bazar puisque
 * vous les éditeriez sûrement à la main en même temps
 *
 * @param {NoteApi} note - l’objet de note de la note stockée
 */
function onNoteStored(note);

/**
 * Cette fonction est appelée après l'ouverture d'une note
 *
 * @param {NoteApi} note - l'objet note qui a été ouvert
 */
function noteOpenedHook(note);

/**
 * Cette fonction est appelée après un double clic sur une note
 *
 * @param {NoteApi} note - l'objet de note sur lequel l'utilisateur a cliqué
 */
function noteDoubleClickedHook(note);

/**
 * @param fileName string le chemin du fichier du fichier multimédia source avant sa copie dans le dossier multimédia
 * @param markdownText string le texte en markdown du fichier multimédia, par exemple ![mon-image](média / mon-image-4101461585.jpg)
 * @return string le nouveau texte Markdown du fichier multimédia
 */
function insertMediaHook(fileName, markdownText);

/**
 * @param fileName string le chemin du fichier de la pièce jointe source avant sa copie dans le dossier de la pièce jointe
 * @param markdownText string le texte en Markdown du fichier joint, par exemple [my-file.txt](pièces jointes/mon-fichier-4245650967.txt)
 * @return string le nouveau texte en Markdown du fichier joint
 */
function insertAttachmentHook(fileName, markdownText);

/**
 * Cette fonction est appelée lorsque du HTML ou un fichier multimédia est collé dans une note avec `Ctrl + Maj + V`
 *
 * @param text texte de l'objet QMimeData
 * @param html HTML de l'objet QMimeData
 * @returns la chaîne à insérer à la place du texte de l'objet QMimeData
 */
function insertingFromMimeDataHook(text, html);

/**
 * Cette fonction est appelée lorsqu'une note est stockée sur le disque si
 * « Autoriser le nom du fichier de note à être différent du titre » est activé
 * dans les préférences
 *
 * Elle vous permet de modifier le nom du fichier de note
 * Gardez à l'esprit que vous devez vous soucier des noms en double !
 *
 * Renvoie une chaîne vide si le nom de fichier de la note ne doit
 * pas être modifié
 *
 * @param {NoteApi} note - l'objet note de la note stockée
 * @return {string} le nom de fichier de la note
 */
function handleNoteTextFileNameHook(note);

/**
 * Cette fonction est appelée lorsque le nom de la note est déterminé pour une note
 *
 * Elle vous permet de modifier le nom de la note qui est visualisée
 *
 * Renvoie une chaîne vide si le nom de la note ne doit pas être modifié
 *
 * @param {NoteApi} note - l'objet note de la note stockée
 * @return {string} le nom de la note
 */
function handleNoteNameHook(note);

/**
 * Cette fonction est appelée avant la création d'une note
 *
 * Elle vous permet de modifier le titre de la note avant sa création
 * Notez que vous devez faire attention à un nom de note unique, sinon
 * la nouvelle note ne sera pas créée, elle sera seulement présente dans la liste des notes
 *
 * Vous pouvez utiliser cette fonction pour créer des modèles de notes
 *
 * @param texte du titre qui serait utilisé pour créer le titre
 * @return {string} le titre de la note
 */
function handleNewNoteHeadlineHook(headline);

/**
 * Cette fonction est appelée avant la génération du code HTML Markdown d'une note
 *
 * Elle vous permet de modifier ce qui est passé au convertisseur Markdown vers HTML
 *
 * La fonction peut par exemple être utilisée dans de multiples scripts pour rendre du code (comme des maths LaTeX ou mermaid)
 * dans sa représentation graphique pour l'aperçu
 *
 * La note ne sera pas modifiée dans ce processus
 *
 * @param {NoteApi} note - l'objet note
 * @param {string} markdown - le Markdown qui doit être converti en HTML
 * @param {bool} forExport - true si le HTML est utilisé pour une exportation, false pour l'aperçu
 * @return {string} le Markdown modifié ou une chaîne vide si rien ne doit être modifié
 */
function preNoteToMarkdownHtmlHook(note, markdown, forExport);

/**
 * Cette fonction est appelée lorsque le code HTML Markdown d'une note est généré
 *
 * Elle vous permet de modifier ce HTML
 * Elle est par exemple appelée avant par l'aperçu de la note
 *
 * Cette fonction peut être utilisée dans plusieurs scripts pour modifier le HTML de l'aperçu
 *
 * @param {NoteApi} note - l'objet note
 * @param {string} html - le HTML qui est doit être rendu
 * @param {bool} forExport - true si le HTML est utilisé pour une exportation, false pour l'aperçu
 * @return {string} le code HTML modifié ou une chaîne vide si rien ne doit être modifié
 */
function noteToMarkdownHtmlHook(note, html, forExport);

/**
 * Cette fonction est appelée lorsque le texte doit être chiffré ou déchiffré
 *
 * @param text string le texte à crypter ou décrypter
 * @param password string le mot de passe
 * @param decrypt bool si un faux chiffrement est demandé, si un vrai déchiffrement est demandé
 * @return le texte déchiffré chiffré
 */
fonction encryptionHook(text, password, decrypt);

/**
 * Gère le tagage pour une note
 *
 * Cette fonction est appelée lorsque des tags sont ajoutés, supprimés ou renommés dans
 * une note ou que les tags d'une note doivent être listés
 *
 * @param note
 * L'action @param peut être « add », « remove », « rename » ou « list »
 * @param tagName nom du tag à ajouter, supprimer ou renommer
 * @param newTagName nom du tag à renommer si action = "rename"
 * @return note chaîne de texte ou chaîne-liste de noms de tags (si action = "list")
 */
function noteTaggingHook(note, action, tagName, newTagName);

/ **
 * Gère le tagage des notes pour une note
 *
 * Cette fonction est appelée lorsque des tags sont ajoutés, supprimés ou renommés dans
 * une note ou que les tags d'une note doivent être listés
 *
 * @param note
 * @param action peut être « add », « remove », « rename » ou « list »
 * @param tag à ajouter, supprimer ou renommer
 * @param newTagName nom de la balise à renommer si action = "rename"
 * @return note chaîne de texte ou liste de chaînes d'identifiants de balises (si action = "list")
 * /
function noteTaggingByObjectHook(note, action, tag, newTagName);

/**
 * Appelle la fonction autocompletionHook pour tous les composants de script
 * Cette fonction est appelée lorsque l'auto-complétion est invoquée dans une note
 *
 * @return QStringListe de texte pour la liste de saisie semi-automatique
 */
function callAutocompletionHook();

/**
 * @param requestType peut être "page" ou "selection"
 * @param pageUrl l’URL de la page web où la requête a été faite
 * @param pageTitle le titre de la page web où la requete a été faite
 * @param rawData les données qui ont été transmises : du HTML pour requestType="page" ou du texte brut pour requestType="selection"
 * @param screenshotDataUrl l’URL de données de la capture d’écran de la page web où la requête a été faite
 * @return true si les données ont été traitées par un hook
 */
function callHandleWebsocketRawDataHook(requestType, pageUrl, pageTitle, rawData, screenshotDataUrl);

/**
 * Cette fonction est appelée lorsqu'un fil de script a fini de s’exécuter.
 * Astuce : thread[1]==0 aide à déterminer si un lot de processus démarrés pour un certain identifiant est terminé.
 *
 * @param {QString} callbackIdentifier - l'identifiant fourni lors de l'appel de startDetachedProcess()
 * @param {QString} resultSet - le résultat du processus
 * @param {QVariantList} cmd - l'ensemble du tableau de commandes [0-executablePath, 1-parameters, 2-exitCode]
 * @param {QVariantList} thread - le tableau d'information sur les fils [0-callbackParameter passé, 1-fils restants pour cet identifiant]
 */
function onDetachedProcessCallback(callbackIdentifier, resultSet, cmd, thread);

/**
 * Cette fonction est appelée après le déclenchement d'un événement WindowStateChange
 *
 * @param {QString} windowState - le nouvel état de la fenêtre, la valeur du paramètre peut être "minimized", "maximized", "fullscreen", "active" ou "nostate"
 */
function windowStateChangedHook(windowState);

/**
 * Cette fonction est appelée quand la disposition est changée
 *
 * @param oldUuid l’ancien UUID de disposition
 * @param newUuid le nouvel UUID de disposition
 */
function layoutSwitchedHook(oldUuid, newUuid);

/**
 * Cette fonction est appelée quand la configuration du service OpenAI est rechargée
 * Elle renvoie une liste d’objets avec des préférences de configurations pour les nouveaux back-ends d’OpenAI
 */
function openAiBackendsHook() {
  return [
    {
      id: "mon-ia-personnalisee",
      name: "Mon IA personnalisée",
      baseUrl: "http://localhost:5000",
      apiKey: "kDFJkjk3asdm",
      models: ["gpt-3.5-turbo", "gpt-4.0-turbo"],
    },
    {
      id: "mon-ia-personnalisee2",
      name: "Mon IA personnalisée 2",
      baseUrl: "http://localhost:5001",
      apiKey: "lOikf7eNdb9",
      models: ["gpt-3.5-turbo2", "gpt-4.0-turbo2"],
    },
  ];
}

/**
 * Cette fonction est appelée pour chaque bloc de texte lors de la coloration syntaxique.
 * Elle permet de la mise en évidence contextuelle et dynamique.
 *
 * @param text {QString} le texte du bloc courant en cours de mise en évidence
 * @param previousBlockState {int} l’état de mise en évidence du bloc précédent
 *     (-1 si c’est le premier bloc)
 * @return {Array} un tableau d’objets highlight range, chacun avec :
 *     start {int} - position de départ dans le texte
 *     length {int} - nombre de caractères à mettre en évidence
 *     state {int} - le HighlighterState à utiliser (optionnel, -1 pour « personnalisé uniquement »)
 *     foregroundColor {string} - nom ou hexadécimal de la couleur de premier plan (optionnel)
 *     backgroundColor {string} - nom ou hexadécimal de la couleur d’arrière-plan (optionnel)
 *     bold {bool} - utiliser le gras (optionnel)
 *     italic {bool} - utiliser l’italique (optionnel)
 *     underline {bool} - souligner le texte (optionnel)
 *     fontSize {int} - taille de la police (optionnel, en pt.)
 */
function highlightingHook(text, previousBlockState) {
  var highlights = [];

  // Example: surligne toutes les occurences de « FIXME » avec un soulignage rouge et en gras
  var re = /FIXME/g;
  var match;
  while ((match = re.exec(text)) !== null) {
    highlights.push({
      start: match.index,
      length: match[0].length,
      foregroundColor: "#ff0000",
      underline: true,
      bold: true,
    });
  }

  return highlights;
}