Improve Anki storeMediaFile (#2084)

* Use the return value of storeMediaFile * Update documentation
FooSoft · Mar 14, 2022 · f98f5f9 · f98f5f9
1 parent 1590f52
commit f98f5f9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 8 deletions.
diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js
@@ -1806,7 +1806,7 @@ class Backend {
         if (extension === null) { extension = '.mp3'; }
         let fileName = this._generateAnkiNoteMediaFileName('yomichan_audio', extension, timestamp, definitionDetails);
         fileName = fileName.replace(/\]/g, '');
-        await ankiConnect.storeMediaFile(fileName, data);
+        fileName = await ankiConnect.storeMediaFile(fileName, data);
 
         return fileName;
     }
@@ -1821,8 +1821,8 @@ class Backend {
             throw new Error('Unknown media type for screenshot image');
         }
 
-        const fileName = this._generateAnkiNoteMediaFileName('yomichan_browser_screenshot', extension, timestamp, definitionDetails);
-        await ankiConnect.storeMediaFile(fileName, data);
+        let fileName = this._generateAnkiNoteMediaFileName('yomichan_browser_screenshot', extension, timestamp, definitionDetails);
+        fileName = await ankiConnect.storeMediaFile(fileName, data);
 
         return fileName;
     }
@@ -1839,8 +1839,8 @@ class Backend {
             throw new Error('Unknown media type for clipboard image');
         }
 
-        const fileName = this._generateAnkiNoteMediaFileName('yomichan_clipboard_image', extension, timestamp, definitionDetails);
-        await ankiConnect.storeMediaFile(fileName, data);
+        let fileName = this._generateAnkiNoteMediaFileName('yomichan_clipboard_image', extension, timestamp, definitionDetails);
+        fileName = await ankiConnect.storeMediaFile(fileName, data);
 
         return fileName;
     }
@@ -1877,7 +1877,7 @@ class Backend {
                 const extension = MediaUtil.getFileExtensionFromImageMediaType(mediaType);
                 fileName = this._generateAnkiNoteMediaFileName(`yomichan_dictionary_media_${i + 1}`, extension, timestamp, definitionDetails);
                 try {
-                    await ankiConnect.storeMediaFile(fileName, content);
+                    fileName = await ankiConnect.storeMediaFile(fileName, content);
                 } catch (e) {
                     errors.push(e);
                     fileName = null;

diff --git a/ext/js/comm/anki.js b/ext/js/comm/anki.js
@@ -105,12 +105,19 @@ class AnkiConnect {
         return await this.guiBrowse(`nid:${noteId}`);
     }
 
-    async storeMediaFile(fileName, dataBase64) {
+    /**
+     * Stores a file with the specified base64-encoded content inside Anki's media folder.
+     * @param {string} fileName The name of the file.
+     * @param {string} content The base64-encoded content of the file.
+     * @returns {?string} The actual file name used to store the file, which may be different; or `null` if the file was not stored.
+     * @throws {Error} An error is thrown is this object is not enabled.
+     */
+    async storeMediaFile(fileName, content) {
         if (!this._enabled) {
             throw new Error('AnkiConnect not enabled');
         }
         await this._checkVersion();
-        return await this._invoke('storeMediaFile', {filename: fileName, data: dataBase64});
+        return await this._invoke('storeMediaFile', {filename: fileName, data: content});
     }
 
     async findNoteIds(notes) {