فهرست منبع

feat: add jsdoc for more explation about my imbriqued function

Corentin NELHOMME 1 سال پیش
والد
کامیت
868ac18dd0
1فایلهای تغییر یافته به همراه87 افزوده شده و 32 حذف شده
  1. 87 32
      index.js

+ 87 - 32
index.js

@@ -1019,6 +1019,10 @@ let NEWSITEEDITOR = (function () {
   let posterUppy = null;
   let videoUppy = null;
 
+  /**
+   * Editeur vidéo du newSiteEditor, permet de modifier la source, le poster, le titre et l'ariaLabel
+   * @param {boolean} enable - Active ou désactive l'éditeur vidéo.
+   */
   function nseVideoEditor(enable) {
     //C'est un truc plus ou moins comme les records en typescript
     const videoInfos = new Map();
@@ -1034,26 +1038,16 @@ let NEWSITEEDITOR = (function () {
     const posterPreview = document.getElementById("posterPreview");
     const videoPreview = document.getElementById("videoPreview");
 
-    //Si le nse est désactivé
-    if (!enable) {
-      closeUppy();
-      hideModal();
-      document.getElementById(buttonId).remove();
-      return;
-    }
-
-    createReplaceButton();
-    setupEventListeners();
-
-    if (!posterUppy || !videoUppy) {
-      [posterUppy, videoUppy] = initializeUppy();
-    }
-
-    //Fonctions pour les Modals
+    /**
+     * Affiche la modal à l'écran
+     */
     function showModal() {
       document.getElementById(videoBackgroundID).style.display = "flex";
     }
 
+    /**
+     * Cache la modal et réinitialise tout les uppys
+     */
     function hideModal() {
       document.getElementById(videoBackgroundID).style.display = "none";
       posterUppy?.cancelAll();
@@ -1061,12 +1055,20 @@ let NEWSITEEDITOR = (function () {
       showPosterStep();
     }
 
-    //Fonctions pour le stepper
+    /**
+     * Affiche l'étape du poster
+     */
     function showPosterStep() {
       document.querySelector("#modalPosterNse").style.display = "block";
       document.querySelector("#modalVideoNse").style.display = "none";
     }
 
+    /**
+     * Affiche l'étape d'édition de vidéo avec les infos actuelles.
+     * @param {Object} info - Informations sur la vidéo.
+     * @param {string} info.title - Titre de la vidéo.
+     * @param {string} info.aria - Aria-label de la vidéo.
+     */
     function showVideoStep(info) {
       document.querySelector("#modalPosterNse").style.display = "none";
       document.querySelector("#modalVideoNse").style.display = "block";
@@ -1074,7 +1076,9 @@ let NEWSITEEDITOR = (function () {
       document.getElementById("ariaLabel").value = info.aria;
     }
 
-    //Initialiser les event listeners
+    /**
+     * Initialise les écouteurs d'évenements nécessaires à l'éditeur.
+     */
     function setupEventListeners() {
       document.getElementById(buttonId).addEventListener("click", () => {
         const button = document.getElementById(buttonId);
@@ -1084,11 +1088,11 @@ let NEWSITEEDITOR = (function () {
         const info = videoInfos.get(currentId);
 
         showModal();
-        document.body.addEventListener('keyup', (e) => {
-          if(e.code === "Escape") {
+        document.body.addEventListener("keyup", (e) => {
+          if (e.code === "Escape") {
             hideModal();
           }
-        })
+        });
         posterPreview.src = info.poster;
         videoPreview.src = info.src;
       });
@@ -1130,11 +1134,13 @@ let NEWSITEEDITOR = (function () {
         .addEventListener("click", () => {
           submitModal();
         });
-
-      
     }
 
-    //Récuperer les infos des vidéos
+    /**
+     * Extrait les informations d'une vidéo à partir du player video.js.
+     * @param {Object} player - Instance du lecteur video.js.
+     * @returns {{poster: string, title: string, aria: string, src: string}} - Informations extraites.
+     */
     function extractVideoInfo(player) {
       const sources = Array.from(player.el().querySelectorAll("source")).map(
         (s) => ({ src: s.src, type: s.type })
@@ -1148,7 +1154,9 @@ let NEWSITEEDITOR = (function () {
       };
     }
 
-    //On crée le bouton une seule fois
+    /**
+     * Crée le bouton flottant "Edit video" s'il n'existe pas déjà.
+     */
     function createReplaceButton() {
       const replaceButton = document.createElement("button");
       replaceButton.innerText = "Edit video";
@@ -1159,7 +1167,12 @@ let NEWSITEEDITOR = (function () {
       document.body.append(replaceButton);
     }
 
-    //Quand l'utilisateur click sur une video ca met a jour la position
+    /**
+     * Met à jour la position du bouton "Edit video" et le data-id courant.
+     * @param {number} x - Position X du clic.
+     * @param {number} y - Position Y du clic.
+     * @param {string} videoId - ID de la vidéo cliquée.
+     */
     function updateReplaceButtonPositionAndDataId(x, y, videoId) {
       const replaceButton = document.getElementById(buttonId);
       if (!replaceButton) return;
@@ -1173,14 +1186,19 @@ let NEWSITEEDITOR = (function () {
       replaceButton.setAttribute("data-currentId", videoId);
     }
 
-    //On initialise le uppy de la vidéo et du poster
+    /**
+     * Initialise les instances Uppy pour le poster et la vidéo.
+     * @returns {[Uppy, Uppy]} - Instances Uppy pour le poster et la vidéo.
+     */
     function initializeUppy() {
       const poster = createPosterUppy();
       const video = createVideoUppy();
       return [poster, video];
     }
 
-    // On détruit les instances de Uppy
+    /**
+     * Détruit les instances Uppy existantes (poster et vidéo).
+     */
     function closeUppy() {
       if (posterUppy) {
         const posterDash = posterUppy.getPlugin("Dashboard");
@@ -1205,6 +1223,10 @@ let NEWSITEEDITOR = (function () {
       }
     }
 
+    /**
+     * Crée l'instance Uppy pour le poster.
+     * @returns {Uppy} - Instance Uppy configurée pour les images.
+     */
     function createPosterUppy() {
       const uppy = new Uppy({
         restrictions: {
@@ -1263,6 +1285,10 @@ let NEWSITEEDITOR = (function () {
       return uppy;
     }
 
+    /**
+     * Crée l'instance Uppy pour la vidéo.
+     * @returns {Uppy} - Instance Uppy configurée pour les vidéos.
+     */
     function createVideoUppy() {
       const uppy = new Uppy({
         restrictions: {
@@ -1297,6 +1323,10 @@ let NEWSITEEDITOR = (function () {
       return uppy;
     }
 
+    /**
+     * Récupère les informations de la vidéo actuellement sélectionnée.
+     * @returns {{poster: string, title: string, aria: string, src: string}} - Infos vidéo actuelle.
+     */
     function getCurrentButtonInfo() {
       const button = document.getElementById(buttonId);
       const currentId = button.getAttribute("data-currentId");
@@ -1304,6 +1334,10 @@ let NEWSITEEDITOR = (function () {
       return info;
     }
 
+    /**
+     * Soumet les données modifiées du modal au serveur.
+     * Met à jour les infos de la Map et le player video.js en conséquence.
+     */
     async function submitModal() {
       const poster = posterUppy.getFiles()[0];
       const video = videoUppy.getFiles()[0];
@@ -1336,17 +1370,38 @@ let NEWSITEEDITOR = (function () {
       const videoOldInfo = videoInfos.get(currentId);
 
       videoInfos.set(currentId, {
-        poster: result.files.poster ? 'http://localhost/php/' + result.files.poster : videoOldInfo.poster,
-        src: result.files.video ? 'http://localhost/php/' + result.files.video : videoOldInfo.src,
+        poster: result.files.poster
+          ? "http://localhost/php/" + result.files.poster
+          : videoOldInfo.poster,
+        src: result.files.video
+          ? "http://localhost/php/" + result.files.video
+          : videoOldInfo.src,
         title: result.title ?? videoOldInfo.title,
         aria: result.text ?? videoOldInfo.aria,
       });
 
       const player = videojs(currentId);
-      player.poster('http://localhost/php/' + result.files.poster);
-      player.src({ src: 'http://localhost/php/' + result.files.video, type: "video/mp4" }); 
+      player.poster("http://localhost/php/" + result.files.poster);
+      player.src({
+        src: "http://localhost/php/" + result.files.video,
+        type: "video/mp4",
+      });
+
+      hideModal();
+    }
 
+    if (!enable) {
+      closeUppy();
       hideModal();
+      document.getElementById(buttonId).remove();
+      return;
+    }
+
+    createReplaceButton();
+    setupEventListeners();
+
+    if (!posterUppy || !videoUppy) {
+      [posterUppy, videoUppy] = initializeUppy();
     }
   }