From e2becdf7a957284ebda60f0e4c1efc224cf153ca Mon Sep 17 00:00:00 2001
From: Cohee <18619528+Cohee1207@users.noreply.github.com>
Date: Sun, 21 Jan 2024 15:19:13 +0200
Subject: [PATCH] Add typedefs for TTS audioJob

---
 public/scripts/extensions/tts/index.js | 26 +++++++++++++++++++-------
 src/endpoints/assets.js                |  2 +-
 2 files changed, 20 insertions(+), 8 deletions(-)

diff --git a/public/scripts/extensions/tts/index.js b/public/scripts/extensions/tts/index.js
index 6411bd2f7..992d973da 100644
--- a/public/scripts/extensions/tts/index.js
+++ b/public/scripts/extensions/tts/index.js
@@ -298,7 +298,7 @@ function debugTtsPlayback() {
         },
     ));
 }
-window.debugTtsPlayback = debugTtsPlayback;
+window['debugTtsPlayback'] = debugTtsPlayback;
 
 //##################//
 //   Audio Control  //
@@ -308,13 +308,25 @@ let audioElement = new Audio();
 audioElement.id = 'tts_audio';
 audioElement.autoplay = true;
 
+/**
+ * @type AudioJob[] Audio job queue
+ * @typedef {{audioBlob: Blob | string, char: string}} AudioJob Audio job object
+ */
 let audioJobQueue = [];
+/**
+ * @type AudioJob Current audio job
+ */
 let currentAudioJob;
 let audioPaused = false;
 let audioQueueProcessorReady = true;
 
+/**
+ * Play audio data from audio job object.
+ * @param {AudioJob} audioJob Audio job object
+ * @returns {Promise<void>} Promise that resolves when audio playback is started
+ */
 async function playAudioData(audioJob) {
-    const audioBlob = audioJob["audioBlob"];
+    const { audioBlob, char } = audioJob;
     // Since current audio job can be cancelled, don't playback if it is null
     if (currentAudioJob == null) {
         console.log('Cancelled TTS playback because currentAudioJob was null');
@@ -324,7 +336,7 @@ async function playAudioData(audioJob) {
 
         // VRM lip sync
         if (extension_settings.vrm?.enabled && typeof window['vrmLipSync'] === 'function') {
-            await window['vrmLipSync'](audioBlob, audioJob["char"]);
+            await window['vrmLipSync'](audioBlob, char);
         }
 
         audioElement.src = srcUrl;
@@ -343,7 +355,7 @@ async function playAudioData(audioJob) {
 window['tts_preview'] = function (id) {
     const audio = document.getElementById(id);
 
-    if (audio && !$(audio).data('disabled')) {
+    if (audio instanceof HTMLAudioElement && !$(audio).data('disabled')) {
         audio.play();
     }
     else {
@@ -429,13 +441,13 @@ function completeCurrentAudioJob() {
  */
 async function addAudioJob(response, char) {
     if (typeof response === 'string') {
-        audioJobQueue.push({"audioBlob":response, "char":char});
+        audioJobQueue.push({ audioBlob: response, char: char });
     } else {
         const audioData = await response.blob();
         if (!audioData.type.startsWith('audio/')) {
             throw `TTS received HTTP response with invalid data format. Expecting audio/*, got ${audioData.type}`;
         }
-        audioJobQueue.push({"audioBlob":audioData, "char":char});
+        audioJobQueue.push({ audioBlob: audioData, char: char });
     }
     console.debug('Pushed audio job to queue.');
 }
@@ -576,7 +588,7 @@ async function playFullConversation() {
     const chat = context.chat;
     ttsJobQueue = chat;
 }
-window.playFullConversation = playFullConversation;
+window['playFullConversation'] = playFullConversation;
 
 //#############################//
 //  Extension UI and Settings  //
diff --git a/src/endpoints/assets.js b/src/endpoints/assets.js
index 0bd160cc2..0284c9e82 100644
--- a/src/endpoints/assets.js
+++ b/src/endpoints/assets.js
@@ -108,7 +108,7 @@ router.post('/get', jsonParser, async (_, response) => {
 
                 // VRM assets
                 if (folder == 'vrm') {
-                    output[folder] = {'model':[], 'animation':[]};
+                    output[folder] = { 'model': [], 'animation': [] };
                     // Extract models
                     const vrm_model_folder = path.normalize(path.join(folderPath, 'vrm', 'model'));
                     let files = getFiles(vrm_model_folder);