@makefully/dutifully 1.10.1 → 1.11.0

package/src/classes/Transcription.js

@@ -1,163 +1,163 @@
-const
-    Cheer = require('./Cheer'),
-    Transcript = require('./Transcript'),
-    fs = require('fs').promises,
-    getCaptions = require('../helpers/getCaptions'),
-    getFileData = require('../helpers/getFileData'),
-    getJSON = require('../helpers/getJSON'),
-    SEPARATE_CHARACTER = '|',
-    JOIN_CHARACTER = '^',
-    filter = (fileType, file) => (file.indexOf('.') !== 0) && (file.slice(-(fileType.length + 1)) === `.${fileType}`),
-    mapReduction = (map, list) => list.reduce((obj, file) => {
-        const
-            id = file.substring(0, file.length - 4);
-
-        obj[id] = map[id];
-        return obj;
-    }, {}),
-    Transcription = class Transcription extends Cheer {
-        async prepare (data) {
-            this.differenceOnly = false;
-            this.updateList = null;
-            await this.replaceConfigPathWithJSON('script', 'files');
-            
-            // create standardized transcripts and an accompanying hash for each.
-            const
-                {files, voice} = this.config,
-                standardizedFiles = {},
-                transcripts = {};
-            
-            Object.keys(files).forEach((key) => {
-                const
-                    transcript = new Transcript(files[key], {voice});
-
-                standardizedFiles[key] = transcript.toJSON();
-                transcripts[key] = transcript;
-            });
-            this.config.files = standardizedFiles;
-            this.transcripts = transcripts;
-
-            return super.prepare(data);
-        }
-
-        async checkDifference () {
-            const
-                {config} = this,
-                {files, format = 'json', output, src} = config,
-                fileType = format.toLowerCase(),
-                {captions: alreadyCaptioned, file: captionsFile, files: fileMap} = await getCaptions(output, fileType),
-                check = (id, caption) => {
-                    const
-                        file = fileMap?.[id],
-                        original = alreadyCaptioned[id],
-                        hash = file?.getHash();
-                        
-                    delete alreadyCaptioned[id];
-                    
-                    if (hash) {
-                        const
-                            same = hash === this.transcripts[id].getHash();
-
-                        if (!same) {
-                            console.log(`Updating "${id}".`);
-                        }
-
-                        return same;
-                    } else {
-                        const
-                            cap = (Array.isArray(caption) ? caption : [caption]).map((cap) => cap?.caption ?? cap ?? null).filter((cap) => cap !== null).join(' ').replaceAll(JOIN_CHARACTER, ' ').replaceAll(SEPARATE_CHARACTER, ' ');
-        
-                        if (cap && cap !== original) {
-                            console.log(`Updating "${id}".`);
-                        }
-
-                        // if a caption is not supplied, we'll assume the existence of an original caption means we don't need to redo.
-                        return cap === '' || cap === original;
-                    }
-                },
-                mergeCaptions = async (newCaptions = false) => { // Must run _after_ all checks and will remove what's left.
-                    const
-                        olds = Object.keys(alreadyCaptioned);
-                        
-                    for (let i = 0; i < olds.length; i++) {
-                        const
-                            caption = olds[i];
-    
-                        if (captionsFile) {
-                            captionsFile.removeKey(caption);
-                        } else {
-                            await fs.rm(`${output}${caption}.${fileType}`);
-                        }
-                        console.log(`Removed "${caption}"`);
-                    }
-                    if (captionsFile) {
-                        if (newCaptions) {
-                            captionsFile.mergeData(await getJSON(`${output}captions.json`));
-                        }
-                        await captionsFile.save();
-                    }
-    
-                    return olds.length;
-                },
-                list = (await fs.readdir(src)).filter(filter.bind(null, 'mp3')).filter((file) => {
-                    const
-                        id = file.substring(0, file.length - 4),
-                        caption = files?.[id];
-
-                    return !check(id, caption);
-                });
-
-            this.differenceOnly = true;
-
-            if (list.length === 0) {
-                // We'll still run the merge in case any have been removed.
-                if (await mergeCaptions()) {
-                    throw Error('Old captions removed, but no new captions required generation.');
-                } else {
-                    throw Error('Captions already up to date.');
-                }
-            }
-
-            this.updateList = list;
-            config.files = mapReduction(files, list);
-            this.mergeCaptions = mergeCaptions;
-        }
-
-        beforeSend (archive) {
-            const
-                {src} = this.config;
-
-            if (this.differenceOnly) {
-                this.updateList.forEach((file) => archive.file(`${src}${file}`, {
-                    name: file
-                }));
-            } else {
-                archive.directory(src, false);
-            }
-            super.beforeSend(archive);
-        }
-
-        async afterExport (...args) {
-            const
-                {config, transcripts, updateList} = this,
-                {format = 'json', output} = config;
-
-            if (this.mergeCaptions) {
-                await this.mergeCaptions(true);
-            }
-            if (format !== 'json') {
-                for (let i = 0; i < updateList.length; i++) {
-                    const
-                        filename = updateList[i],
-                        id = filename.substring(0, filename.length - 4),
-                        file = await getFileData(`${output}${id}.${format}`, format);
-
-                    file.addHash(transcripts[id].getHash());
-                    await file.save();
-                }
-            }
-            super.afterExport(...args)
-        }
-    };
-
+const
+    Cheer = require('./Cheer'),
+    Transcript = require('./Transcript'),
+    fs = require('fs').promises,
+    getCaptions = require('../helpers/getCaptions'),
+    getFileData = require('../helpers/getFileData'),
+    getJSON = require('../helpers/getJSON'),
+    SEPARATE_CHARACTER = '|',
+    JOIN_CHARACTER = '^',
+    filter = (fileType, file) => (file.indexOf('.') !== 0) && (file.slice(-(fileType.length + 1)) === `.${fileType}`),
+    mapReduction = (map, list) => list.reduce((obj, file) => {
+        const
+            id = file.substring(0, file.length - 4);
+
+        obj[id] = map[id];
+        return obj;
+    }, {}),
+    Transcription = class Transcription extends Cheer {
+        async prepare (data) {
+            this.differenceOnly = false;
+            this.updateList = null;
+            await this.replaceConfigPathWithJSON('script', 'files');
+            
+            // create standardized transcripts and an accompanying hash for each.
+            const
+                {files, voice} = this.config,
+                standardizedFiles = {},
+                transcripts = {};
+            
+            Object.keys(files).forEach((key) => {
+                const
+                    transcript = new Transcript(files[key], {voice});
+
+                standardizedFiles[key] = transcript.toJSON();
+                transcripts[key] = transcript;
+            });
+            this.config.files = standardizedFiles;
+            this.transcripts = transcripts;
+
+            return super.prepare(data);
+        }
+
+        async checkDifference () {
+            const
+                {config} = this,
+                {files, format = 'json', output, src} = config,
+                fileType = format.toLowerCase(),
+                {captions: alreadyCaptioned, file: captionsFile, files: fileMap} = await getCaptions(output, fileType),
+                check = (id, caption) => {
+                    const
+                        file = fileMap?.[id],
+                        original = alreadyCaptioned[id],
+                        hash = file?.getHash();
+                        
+                    delete alreadyCaptioned[id];
+                    
+                    if (hash) {
+                        const
+                            same = hash === this.transcripts[id].getHash();
+
+                        if (!same) {
+                            console.log(`Updating "${id}".`);
+                        }
+
+                        return same;
+                    } else {
+                        const
+                            cap = (Array.isArray(caption) ? caption : [caption]).map((cap) => cap?.caption ?? cap ?? null).filter((cap) => cap !== null).join(' ').replaceAll(JOIN_CHARACTER, ' ').replaceAll(SEPARATE_CHARACTER, ' ');
+        
+                        if (cap && cap !== original) {
+                            console.log(`Updating "${id}".`);
+                        }
+
+                        // if a caption is not supplied, we'll assume the existence of an original caption means we don't need to redo.
+                        return cap === '' || cap === original;
+                    }
+                },
+                mergeCaptions = async (newCaptions = false) => { // Must run _after_ all checks and will remove what's left.
+                    const
+                        olds = Object.keys(alreadyCaptioned);
+                        
+                    for (let i = 0; i < olds.length; i++) {
+                        const
+                            caption = olds[i];
+    
+                        if (captionsFile) {
+                            captionsFile.removeKey(caption);
+                        } else {
+                            await fs.rm(`${output}${caption}.${fileType}`);
+                        }
+                        console.log(`Removed "${caption}"`);
+                    }
+                    if (captionsFile) {
+                        if (newCaptions) {
+                            captionsFile.mergeData(await getJSON(`${output}captions.json`));
+                        }
+                        await captionsFile.save();
+                    }
+    
+                    return olds.length;
+                },
+                list = (await fs.readdir(src)).filter(filter.bind(null, 'mp3')).filter((file) => {
+                    const
+                        id = file.substring(0, file.length - 4),
+                        caption = files?.[id];
+
+                    return !check(id, caption);
+                });
+
+            this.differenceOnly = true;
+
+            if (list.length === 0) {
+                // We'll still run the merge in case any have been removed.
+                if (await mergeCaptions()) {
+                    throw Error('Old captions removed, but no new captions required generation.');
+                } else {
+                    throw Error('Captions already up to date.');
+                }
+            }
+
+            this.updateList = list;
+            config.files = mapReduction(files, list);
+            this.mergeCaptions = mergeCaptions;
+        }
+
+        beforeSend (archive) {
+            const
+                {src} = this.config;
+
+            if (this.differenceOnly) {
+                this.updateList.forEach((file) => archive.file(`${src}${file}`, {
+                    name: file
+                }));
+            } else {
+                archive.directory(src, false);
+            }
+            super.beforeSend(archive);
+        }
+
+        async afterExport (...args) {
+            const
+                {config, transcripts, updateList} = this,
+                {format = 'json', output} = config;
+
+            if (this.mergeCaptions) {
+                await this.mergeCaptions(true);
+            }
+            if (format !== 'json') {
+                for (let i = 0; i < updateList.length; i++) {
+                    const
+                        filename = updateList[i],
+                        id = filename.substring(0, filename.length - 4),
+                        file = await getFileData(`${output}${id}.${format}`, format);
+
+                    file.addHash(transcripts[id].getHash());
+                    await file.save();
+                }
+            }
+            super.afterExport(...args)
+        }
+    };
+
 module.exports = Transcription;

package/src/formats/File.js

@@ -1,27 +1,27 @@
-const
-    fs = require('fs').promises,
-    File = class {
-        constructor ({fileType}) {
-            this.data = null;
-            this.fileType = fileType;
-        }
-
-        async load (path) {
-            this.path = path;
-            return null;
-        }
-
-        getHash () {
-            return null; // does not support hashes.
-        }
-
-        save () { // return a promise
-            return fs.writeFile(`${this.path}`, this.data ?? '');
-        }
-
-        toString () {
-            return '';
-        }
-    }
-
+const
+    fs = require('fs').promises,
+    File = class {
+        constructor ({fileType}) {
+            this.data = null;
+            this.fileType = fileType;
+        }
+
+        async load (path) {
+            this.path = path;
+            return null;
+        }
+
+        getHash () {
+            return null; // does not support hashes.
+        }
+
+        save () { // return a promise
+            return fs.writeFile(`${this.path}`, this.data ?? '');
+        }
+
+        toString () {
+            return '';
+        }
+    }
+
 module.exports = File;

package/src/formats/JSONFile.js

@@ -1,40 +1,40 @@
-const
-    crypto = require('crypto'),
-    fs = require('fs').promises,
-    File = require("./File"),
-    getJSON = require('../helpers/getJSON'),
-    sortKeys = (obj) => Object.keys(obj).sort().reduce((s, key) => {
-        s[key] = obj[key];
-        return s;
-    }, {});
-
-module.exports = class JSONFile extends File {
-    async load (path) {
-        await super.load(path);
-        this.data = await getJSON(path);
-        return this.data;
-    }
-
-    getHash () {
-        return this.data ? crypto.createHash('sha256').update(JSON.stringify(this.data)).digest('hex') : null;
-    }
-
-    toString () {
-        return Object.keys(this.data).map((key) => this.data[key].map(({content}) => content).join(' ')).join('\n');
-    }
-
-    removeKey (key) {
-        delete this.data[key];
-    }
-
-    mergeData (data) {
-        this.data = sortKeys({
-            ...this.data,
-            ...data
-        });
-    }
-
-    save () { // return a promise
-        return fs.writeFile(`${this.path}`, JSON.stringify(this.data, null, 4));
-    }
+const
+    crypto = require('crypto'),
+    fs = require('fs').promises,
+    File = require("./File"),
+    getJSON = require('../helpers/getJSON'),
+    sortKeys = (obj) => Object.keys(obj).sort().reduce((s, key) => {
+        s[key] = obj[key];
+        return s;
+    }, {});
+
+module.exports = class JSONFile extends File {
+    async load (path) {
+        await super.load(path);
+        this.data = await getJSON(path);
+        return this.data;
+    }
+
+    getHash () {
+        return this.data ? crypto.createHash('sha256').update(JSON.stringify(this.data)).digest('hex') : null;
+    }
+
+    toString () {
+        return Object.keys(this.data).map((key) => this.data[key].map(({content}) => content).join(' ')).join('\n');
+    }
+
+    removeKey (key) {
+        delete this.data[key];
+    }
+
+    mergeData (data) {
+        this.data = sortKeys({
+            ...this.data,
+            ...data
+        });
+    }
+
+    save () { // return a promise
+        return fs.writeFile(`${this.path}`, JSON.stringify(this.data, null, 4));
+    }
 }

package/src/formats/LRC.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 LRC 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(/^\[hash:[a-f0-9]+\]\n?/im, '');
-
-        const
-            sep = getSeparater(this.data),
-            insertAfter = this.data.match(/^\[generator:[^\]]*\]/im);
-
-        if (insertAfter) {
-            this.data = this.data.replace(insertAfter[0], `${insertAfter[0]}${sep}[hash:${hash}]`);
-        } else {
-            this.data = `[hash:${hash}]${sep}${this.data}`;
-        }
-    }
-
-    getHash () {
-        const
-            match = this.data.match(/^\[hash:([a-f0-9]+)\]/im);
-
-        return match ? match[1] : null;
-    }
-
-    toString () {
-        return this.data.split(getSeparater(this.data)).filter((line) => line.length > 0 && line.indexOf('[') === 0 && line.indexOf(']') === 9).map((text) => text.substring(10)).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 LRC 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(/^\[hash:[a-f0-9]+\]\n?/im, '');
+
+        const
+            sep = getSeparater(this.data),
+            insertAfter = this.data.match(/^\[generator:[^\]]*\]/im);
+
+        if (insertAfter) {
+            this.data = this.data.replace(insertAfter[0], `${insertAfter[0]}${sep}[hash:${hash}]`);
+        } else {
+            this.data = `[hash:${hash}]${sep}${this.data}`;
+        }
+    }
+
+    getHash () {
+        const
+            match = this.data.match(/^\[hash:([a-f0-9]+)\]/im);
+
+        return match ? match[1] : null;
+    }
+
+    toString () {
+        return this.data.split(getSeparater(this.data)).filter((line) => line.length > 0 && line.indexOf('[') === 0 && line.indexOf(']') === 9).map((text) => text.substring(10)).join(' ');
+    }
 }

package/src/formats/MP3.js

@@ -1,60 +1,60 @@
-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");
+
+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 '';
+    }
 }