@makefully/dutifully 1.10.1 → 1.12.0

package/src/formats/MP3.js

@@ -1,60 +1,62 @@
-const
-    id3 = require('node-id3').Promise,
-    File = require("./File");
-
-module.exports = class MP3 extends File {
-    async load (path) {
-        await super.load(path);
-        this.data = await id3.read(path);
-        return this.data;
-    }
-
-    addHash (hash, {hashKey = 'CaptionHash'} = {}) {
-        const
-            existing = (this.data.userDefinedText ?? []).filter(({description}) => description !== hashKey);
-
-        this.data.userDefinedText = [...existing, {description: hashKey, value: hash}];
-    }
-
-    getHash ({hashKey = 'CaptionHash'} = {}) {
-        const
-            {userDefinedText} = this.data;
-
-        if (userDefinedText) {
-            for (let i = 0; i < userDefinedText.length; i++) {
-                if (userDefinedText[i].description === hashKey) {
-                    return userDefinedText[i].value;
-                }
-            }
-        }
-
-        return null;
-    }
-
-    save () { // return a promise
-        return id3.write(this.data, this.path);
-    }
-
-    toString () {
-        const
-            {synchronisedLyrics, unsynchronisedLyrics} = this.data;
-
-        if (unsynchronisedLyrics?.text) {
-            return unsynchronisedLyrics.text;
-        }
-
-        if (synchronisedLyrics) {
-            const
-                index = synchronisedLyrics.map(({shortText}) => shortText).indexOf('captions');
-
-            if (index >= 0) {
-                const
-                    {synchronisedText} = synchronisedLyrics[index];
-
-                return synchronisedText.map(({text}) => text).join(' ');
-            }
-        }
-
-        return '';
-    }
+const
+    id3 = require('node-id3').Promise,
+    File = require("./File"),
+    {ensureParentDir} = require('../helpers/dirs');
+
+module.exports = class MP3 extends File {
+    async load (path) {
+        await super.load(path);
+        this.data = await id3.read(path);
+        return this.data;
+    }
+
+    addHash (hash, {hashKey = 'CaptionHash'} = {}) {
+        const
+            existing = (this.data.userDefinedText ?? []).filter(({description}) => description !== hashKey);
+
+        this.data.userDefinedText = [...existing, {description: hashKey, value: hash}];
+    }
+
+    getHash ({hashKey = 'CaptionHash'} = {}) {
+        const
+            {userDefinedText} = this.data;
+
+        if (userDefinedText) {
+            for (let i = 0; i < userDefinedText.length; i++) {
+                if (userDefinedText[i].description === hashKey) {
+                    return userDefinedText[i].value;
+                }
+            }
+        }
+
+        return null;
+    }
+
+    async save () { // return a promise
+        await ensureParentDir(this.path);
+        return id3.write(this.data, this.path);
+    }
+
+    toString () {
+        const
+            {synchronisedLyrics, unsynchronisedLyrics} = this.data;
+
+        if (unsynchronisedLyrics?.text) {
+            return unsynchronisedLyrics.text;
+        }
+
+        if (synchronisedLyrics) {
+            const
+                index = synchronisedLyrics.map(({shortText}) => shortText).indexOf('captions');
+
+            if (index >= 0) {
+                const
+                    {synchronisedText} = synchronisedLyrics[index];
+
+                return synchronisedText.map(({text}) => text).join(' ');
+            }
+        }
+
+        return '';
+    }
 }

package/src/formats/SAMI.js

@@ -1,59 +1,59 @@
-const
-    fs = require('fs').promises,
-    File = require("./File"),
-    removeComments = (html) => html.replace(/<!--[\s\S]*?-->/g, ''),
-    cleanHTML = (html) => html
-        .replace(/<[^>]+>/g, '')   // remove HTML tags
-        .replace(/&nbsp;/gi, ' ')  // decode common HTML entities
-        .replace(/&amp;/gi, '&')
-        .replace(/&lt;/gi, '<')
-        .replace(/&gt;/gi, '>')
-        .replace(/&quot;/gi, '"')
-        .trim();
-
-module.exports = class SAMI extends File {
-    async load (path) {
-        await super.load(path);
-        this.data = await fs.readFile(path, 'utf8');
-        return this.data;
-    }
-
-    addHash (hash) {
-        this.data = this.data.replace(/<META[\s]+Hash="[a-f0-9]+"[\s]*\/>\n?/i, '');
-
-        const
-            insertAfter = this.data.match(/<META[\s]+Generator="[^"]*"[\s]*\/>/i);
-
-        if (insertAfter) {
-            this.data = this.data.replace(insertAfter[0], `${insertAfter[0]}\n    <META Hash="${hash}"/>`);
-        } else {
-            this.data = this.data.replace(/<HEAD>/i, `<HEAD>\n    <META Hash="${hash}"/>`);
-        }
-    }
-    
-    getHash () {
-        const
-            match = this.data.match(/<META[\s]+Hash="([a-f0-9]+)"/i);
-
-        return match ? match[1] : null;
-    }
-
-    toString () {
-        const
-            sami = removeComments(this.data),
-            regex = /<P[^>]*>([\s\S]*?)<\/P>/gi,
-            matches = [];
-        let match;
-
-        while ((match = regex.exec(sami)) !== null) {
-            const
-                innerText = cleanHTML(match[1]);
-                
-            if (innerText) {
-                matches.push(innerText);
-            }
-        }
-                
-        return matches.join(' ');
-    }
+const
+    fs = require('fs').promises,
+    File = require("./File"),
+    removeComments = (html) => html.replace(/<!--[\s\S]*?-->/g, ''),
+    cleanHTML = (html) => html
+        .replace(/<[^>]+>/g, '')   // remove HTML tags
+        .replace(/&nbsp;/gi, ' ')  // decode common HTML entities
+        .replace(/&amp;/gi, '&')
+        .replace(/&lt;/gi, '<')
+        .replace(/&gt;/gi, '>')
+        .replace(/&quot;/gi, '"')
+        .trim();
+
+module.exports = class SAMI extends File {
+    async load (path) {
+        await super.load(path);
+        this.data = await fs.readFile(path, 'utf8');
+        return this.data;
+    }
+
+    addHash (hash) {
+        this.data = this.data.replace(/<META[\s]+Hash="[a-f0-9]+"[\s]*\/>\n?/i, '');
+
+        const
+            insertAfter = this.data.match(/<META[\s]+Generator="[^"]*"[\s]*\/>/i);
+
+        if (insertAfter) {
+            this.data = this.data.replace(insertAfter[0], `${insertAfter[0]}\n    <META Hash="${hash}"/>`);
+        } else {
+            this.data = this.data.replace(/<HEAD>/i, `<HEAD>\n    <META Hash="${hash}"/>`);
+        }
+    }
+    
+    getHash () {
+        const
+            match = this.data.match(/<META[\s]+Hash="([a-f0-9]+)"/i);
+
+        return match ? match[1] : null;
+    }
+
+    toString () {
+        const
+            sami = removeComments(this.data),
+            regex = /<P[^>]*>([\s\S]*?)<\/P>/gi,
+            matches = [];
+        let match;
+
+        while ((match = regex.exec(sami)) !== null) {
+            const
+                innerText = cleanHTML(match[1]);
+                
+            if (innerText) {
+                matches.push(innerText);
+            }
+        }
+                
+        return matches.join(' ');
+    }
 }

package/src/formats/SRT.js

@@ -1,40 +1,40 @@
-const
-    fs = require('fs').promises,
-    os = require('os'),
-    File = require("./File"),
-    getSeparater = (str) => str.indexOf(os.EOL) >= 0 ? os.EOL : '\n';
-
-module.exports = class SRT extends File {
-    async load (path) {
-        await super.load(path);
-        this.data = await fs.readFile(path, 'utf8');
-        return this.data;
-    }
-
-    addHash (hash) {
-        this.data = this.data.replace(/<u[\s]+hash="[a-f0-9]+"[\s]*(?:\/>|><\/u>)\n?/im, '');
-
-        const
-            insertAfter = this.data.match(/<u[\s]+generator="[^"]*"[\s]*(?:\/>|><\/u>)/im);
-
-        if (insertAfter) {
-            this.data = this.data.replace(insertAfter[0], `${insertAfter[0]}${getSeparater(this.data)}<u hash="${hash}"></u>`);
-        } else {
-            const
-                sep = getSeparater(this.data);
-
-            this.data = `1${sep}00:00:00,000 --> 00:00:00,001${sep}<u hash="${hash}"></u>${sep}${sep}${this.data}`;
-        }
-    }
-
-    getHash () {
-        const
-            match = this.data.match(/<u[\s]+hash="([a-f0-9]+)"[\s]*(?:\/>|><\/u>)/im);
-
-        return match ? match[1] : null;
-    }
-
-    toString () {
-        return this.data.split(getSeparater(this.data)).filter((line) => line.length > 0 && line.indexOf(' --> ') === -1 && parseInt(line) != line).join(' ');
-    }
+const
+    fs = require('fs').promises,
+    os = require('os'),
+    File = require("./File"),
+    getSeparater = (str) => str.indexOf(os.EOL) >= 0 ? os.EOL : '\n';
+
+module.exports = class SRT extends File {
+    async load (path) {
+        await super.load(path);
+        this.data = await fs.readFile(path, 'utf8');
+        return this.data;
+    }
+
+    addHash (hash) {
+        this.data = this.data.replace(/<u[\s]+hash="[a-f0-9]+"[\s]*(?:\/>|><\/u>)\n?/im, '');
+
+        const
+            insertAfter = this.data.match(/<u[\s]+generator="[^"]*"[\s]*(?:\/>|><\/u>)/im);
+
+        if (insertAfter) {
+            this.data = this.data.replace(insertAfter[0], `${insertAfter[0]}${getSeparater(this.data)}<u hash="${hash}"></u>`);
+        } else {
+            const
+                sep = getSeparater(this.data);
+
+            this.data = `1${sep}00:00:00,000 --> 00:00:00,001${sep}<u hash="${hash}"></u>${sep}${sep}${this.data}`;
+        }
+    }
+
+    getHash () {
+        const
+            match = this.data.match(/<u[\s]+hash="([a-f0-9]+)"[\s]*(?:\/>|><\/u>)/im);
+
+        return match ? match[1] : null;
+    }
+
+    toString () {
+        return this.data.split(getSeparater(this.data)).filter((line) => line.length > 0 && line.indexOf(' --> ') === -1 && parseInt(line) != line).join(' ');
+    }
 }

package/src/formats/VTT.js

@@ -1,38 +1,38 @@
-const
-    fs = require('fs').promises,
-    os = require('os'),
-    File = require("./File"),
-    getSeparater = (str) => str.indexOf(os.EOL) >= 0 ? os.EOL : '\n';
-
-module.exports = class VTT extends File {
-    async load (path) {
-        await super.load(path);
-        this.data = await fs.readFile(path, 'utf8');
-        return this.data;
-    }
-
-    addHash (hash) {
-        this.data = this.data.replace(/^NOTE[\s]+Hash:[\s]+[a-f0-9]+\n?/im, '');
-
-        const
-            sep = getSeparater(this.data),
-            insertAfter = this.data.match(/^NOTE[\s]+Generator:[^\n]*/im);
-
-        if (insertAfter) {
-            this.data = this.data.replace(insertAfter[0], `${insertAfter[0]}${sep}NOTE Hash: ${hash}`);
-        } else {
-            this.data = this.data.replace('WEBVTT', `WEBVTT${sep}${sep}NOTE Hash: ${hash}`);
-        }
-    }
-    
-    getHash () {
-        const
-            match = this.data.match(/^NOTE[\s]+Hash:[\s]+([a-f0-9]+)/im);
-
-        return match ? match[1] : null;
-    }
-
-    toString () {
-        return this.data.split(getSeparater(this.data)).filter((line) => line.length > 0 && line.indexOf(' --> ') === -1 && parseInt(line) != line).join(' ');
-    }
+const
+    fs = require('fs').promises,
+    os = require('os'),
+    File = require("./File"),
+    getSeparater = (str) => str.indexOf(os.EOL) >= 0 ? os.EOL : '\n';
+
+module.exports = class VTT extends File {
+    async load (path) {
+        await super.load(path);
+        this.data = await fs.readFile(path, 'utf8');
+        return this.data;
+    }
+
+    addHash (hash) {
+        this.data = this.data.replace(/^NOTE[\s]+Hash:[\s]+[a-f0-9]+\n?/im, '');
+
+        const
+            sep = getSeparater(this.data),
+            insertAfter = this.data.match(/^NOTE[\s]+Generator:[^\n]*/im);
+
+        if (insertAfter) {
+            this.data = this.data.replace(insertAfter[0], `${insertAfter[0]}${sep}NOTE Hash: ${hash}`);
+        } else {
+            this.data = this.data.replace('WEBVTT', `WEBVTT${sep}${sep}NOTE Hash: ${hash}`);
+        }
+    }
+    
+    getHash () {
+        const
+            match = this.data.match(/^NOTE[\s]+Hash:[\s]+([a-f0-9]+)/im);
+
+        return match ? match[1] : null;
+    }
+
+    toString () {
+        return this.data.split(getSeparater(this.data)).filter((line) => line.length > 0 && line.indexOf(' --> ') === -1 && parseInt(line) != line).join(' ');
+    }
 }

package/src/helpers/dirs.js

@@ -0,0 +1,30 @@
+const
+    fs = require('fs').promises,
+    path = require('path'),
+    ensureDir = async (dir) => {
+        if (dir) {
+            await fs.mkdir(dir, {recursive: true});
+        }
+    },
+    ensureParentDir = async (filePath) => {
+        if (filePath) {
+            await ensureDir(path.dirname(filePath));
+        }
+    },
+    readdirOrEmpty = async (dir) => {
+        try {
+            return await fs.readdir(dir);
+        } catch (e) {
+            if (e?.code === 'ENOENT') {
+                return [];
+            }
+
+            throw e;
+        }
+    };
+
+module.exports = {
+    ensureDir,
+    ensureParentDir,
+    readdirOrEmpty
+};

package/src/helpers/getCaptions.js

@@ -1,44 +1,44 @@
-const
-    fs = require('fs').promises,
-    getFileData = require("./getFileData"),
-    filter = (fileType, file) => (file.indexOf('.') !== 0) && (file.slice(-(fileType.length + 1)) === `.${fileType}`);
-
-module.exports = async (path, fileType) => {
-
-    // "captions.json" is a proprietary format that includes all captions.
-    if (fileType.toLowerCase() === 'json') {
-        const
-            file = await getFileData(`${path}captions.json`, 'json'),
-            {data: json} = file;
-
-        return {
-            captions: Object.keys(json).reduce((obj, key) => {
-                obj[key] = json[key].map(({content}) => content).join(' ');
-                return obj;
-            }, {}),
-            file,
-            files: null
-        };
-    } else { // Otherwise we pull all the files and construct a key/value object.
-        const
-            files = (await fs.readdir(path)).filter(filter.bind(null, fileType)),
-            captions = {},
-            fileMap = {};
-            
-        for (let i = 0; i < files.length; i++) {
-            const
-                filename = files[i],
-                file = await getFileData(`${path}${filename}`, fileType),
-                key = filename.substring(0, filename.length - fileType.length - 1);
-                
-            captions[key] = file.toString();
-            fileMap[key] = file;
-        }
-
-        return {
-            captions,
-            file: null,
-            files: fileMap
-        };
-    }
+const
+    getFileData = require("./getFileData"),
+    {readdirOrEmpty} = require("./dirs"),
+    filter = (fileType, file) => (file.indexOf('.') !== 0) && (file.slice(-(fileType.length + 1)) === `.${fileType}`);
+
+module.exports = async (path, fileType) => {
+
+    // "captions.json" is a proprietary format that includes all captions.
+    if (fileType.toLowerCase() === 'json') {
+        const
+            file = await getFileData(`${path}captions.json`, 'json'),
+            {data: json = {}} = file;
+
+        return {
+            captions: Object.keys(json ?? {}).reduce((obj, key) => {
+                obj[key] = json[key].map(({content}) => content).join(' ');
+                return obj;
+            }, {}),
+            file,
+            files: null
+        };
+    } else { // Otherwise we pull all the files and construct a key/value object.
+        const
+            files = (await readdirOrEmpty(path)).filter(filter.bind(null, fileType)),
+            captions = {},
+            fileMap = {};
+            
+        for (let i = 0; i < files.length; i++) {
+            const
+                filename = files[i],
+                file = await getFileData(`${path}${filename}`, fileType),
+                key = filename.substring(0, filename.length - fileType.length - 1);
+                
+            captions[key] = file.toString();
+            fileMap[key] = file;
+        }
+
+        return {
+            captions,
+            file: null,
+            files: fileMap
+        };
+    }
 };

package/src/helpers/getFileData.js

@@ -1,33 +1,33 @@
-const
-    JSONFile = require("../formats/JSONFile"),
-    LRC = require("../formats/LRC"),
-    MP3 = require("../formats/MP3"),
-    SAMI = require("../formats/SAMI"),
-    SRT = require("../formats/SRT"),
-    VTT = require("../formats/VTT"),
-    formats = {
-        json: JSONFile,
-        lrc: LRC,
-        mp3: MP3,
-        sami: SAMI,
-        smi: SAMI,
-        srt: SRT,
-        vtt: VTT
-    };
-
-module.exports = async (path, fileType) => {
-    const
-        lcFormat = fileType.toLowerCase(),
-        File = formats[lcFormat] ?? formats.JSONFile;
-
-    // Find file type and throw if that doesn't work.
-    if (File) {
-        const
-            file = new File({fileType: lcFormat});
-
-        await file.load(path);
-        return file;
-    } else {
-        throw `"${fileType}" not supported.`;
-    }
+const
+    JSONFile = require("../formats/JSONFile"),
+    LRC = require("../formats/LRC"),
+    MP3 = require("../formats/MP3"),
+    SAMI = require("../formats/SAMI"),
+    SRT = require("../formats/SRT"),
+    VTT = require("../formats/VTT"),
+    formats = {
+        json: JSONFile,
+        lrc: LRC,
+        mp3: MP3,
+        sami: SAMI,
+        smi: SAMI,
+        srt: SRT,
+        vtt: VTT
+    };
+
+module.exports = async (path, fileType) => {
+    const
+        lcFormat = fileType.toLowerCase(),
+        File = formats[lcFormat] ?? formats.JSONFile;
+
+    // Find file type and throw if that doesn't work.
+    if (File) {
+        const
+            file = new File({fileType: lcFormat});
+
+        await file.load(path);
+        return file;
+    } else {
+        throw `"${fileType}" not supported.`;
+    }
 };

package/src/helpers/getJSON.js

@@ -1,33 +1,33 @@
-const
-    fs = require('fs'),
-    getJSON = (path) => new Promise ((resolve, reject) => {
-        fs.readFile(path, (err, data) => {
-            if (err) {
-                reject(err);
-            } else {
-                let json = null;
-                
-                try {
-                    json = JSON.parse(data);
-                } catch (e) {
-                    reject(e);
-                }
-        
-                if (json) {
-                    resolve(json);
-                }
-            }
-        });
-    });
-
-module.exports = async (path) => {
-    let json = null;
-    
-    try {
-        json = await getJSON(path);
-    } catch (e) {
-        console.warn(e);
-    }
-
-    return json;
+const
+    fs = require('fs'),
+    getJSON = (path) => new Promise ((resolve, reject) => {
+        fs.readFile(path, (err, data) => {
+            if (err) {
+                reject(err);
+            } else {
+                let json = null;
+                
+                try {
+                    json = JSON.parse(data);
+                } catch (e) {
+                    reject(e);
+                }
+        
+                if (json) {
+                    resolve(json);
+                }
+            }
+        });
+    });
+
+module.exports = async (path) => {
+    let json = null;
+    
+    try {
+        json = await getJSON(path);
+    } catch (e) {
+        console.warn(e);
+    }
+
+    return json;
 };