@helloao/tools 0.0.1

package/generation/api.spec.js

@@ -0,0 +1,463 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const api_1 = require("./api");
+const _01GENBSB_usfm_1 = __importDefault(require("../../../bible/bsb/01GENBSB.usfm"));
+const _02EXOBSB_usfm_1 = __importDefault(require("../../../bible/bsb/02EXOBSB.usfm"));
+const _131CHBSB_usfm_1 = __importDefault(require("../../../bible/bsb/131CHBSB.usfm"));
+const dataset_1 = require("./dataset");
+const linkedom_1 = require("linkedom");
+describe('replaceSpacesWithUnderscores()', () => {
+    const cases = [
+        ['Hello World', 'Hello_World'],
+        ['Hello World 2', 'Hello_World_2'],
+    ];
+    it.each(cases)('should replace spaces with underscores', (input, expected) => {
+        expect((0, api_1.replaceSpacesWithUnderscores)(input)).toBe(expected);
+    });
+});
+describe('generateApiForDataset()', () => {
+    it('should output a file tree', () => {
+        let translation1 = {
+            id: 'bsb',
+            name: 'Berean Standard Bible',
+            englishName: 'Berean Standard Bible',
+            shortName: 'BSB',
+            language: 'eng',
+            direction: 'ltr',
+            licenseUrl: 'https://berean.bible/terms.htm',
+            website: 'https://berean.bible'
+        };
+        let inputFiles = [
+            {
+                fileType: 'usfm',
+                metadata: {
+                    translation: translation1
+                },
+                content: firstXLines(_01GENBSB_usfm_1.default, 13)
+            },
+            {
+                fileType: 'usfm',
+                metadata: {
+                    translation: translation1
+                },
+                content: firstXLines(_02EXOBSB_usfm_1.default, 14)
+            }
+        ];
+        const dataset = (0, dataset_1.generateDataset)(inputFiles, new linkedom_1.DOMParser());
+        const generated = (0, api_1.generateApiForDataset)(dataset);
+        const files = (0, api_1.generateFilesForApi)(generated);
+        const tree = fileTree(files);
+        const expectedTranslation = {
+            id: 'bsb',
+            name: 'Berean Standard Bible',
+            englishName: 'Berean Standard Bible',
+            shortName: 'BSB',
+            language: 'eng',
+            textDirection: 'ltr',
+            licenseUrl: 'https://berean.bible/terms.htm',
+            website: 'https://berean.bible',
+            availableFormats: [
+                'json'
+            ],
+            listOfBooksApiLink: '/api/bsb/books.json',
+            numberOfBooks: 2,
+            totalNumberOfChapters: 2,
+            totalNumberOfVerses: 4,
+            languageName: 'English',
+            languageEnglishName: 'English',
+        };
+        expect(tree).toEqual({
+            '/api/available_translations.json': {
+                translations: [
+                    expectedTranslation
+                ]
+            },
+            '/api/bsb/books.json': {
+                translation: expectedTranslation,
+                books: [
+                    {
+                        id: 'GEN',
+                        name: 'Genesis',
+                        commonName: 'Genesis',
+                        title: 'Genesis',
+                        order: 1,
+                        numberOfChapters: 1,
+                        totalNumberOfVerses: 2,
+                        firstChapterApiLink: '/api/bsb/GEN/1.json',
+                        lastChapterApiLink: '/api/bsb/GEN/1.json',
+                    },
+                    {
+                        id: 'EXO',
+                        name: 'Exodus',
+                        commonName: 'Exodus',
+                        title: 'Exodus',
+                        order: 2,
+                        numberOfChapters: 1,
+                        totalNumberOfVerses: 2,
+                        firstChapterApiLink: '/api/bsb/EXO/1.json',
+                        lastChapterApiLink: '/api/bsb/EXO/1.json',
+                    }
+                ]
+            },
+            '/api/bsb/GEN/1.json': {
+                translation: expectedTranslation,
+                book: {
+                    id: 'GEN',
+                    name: 'Genesis',
+                    commonName: 'Genesis',
+                    title: 'Genesis',
+                    order: 1,
+                    numberOfChapters: 1,
+                    totalNumberOfVerses: 2,
+                    firstChapterApiLink: '/api/bsb/GEN/1.json',
+                    lastChapterApiLink: '/api/bsb/GEN/1.json'
+                },
+                thisChapterLink: '/api/bsb/GEN/1.json',
+                thisChapterAudioLinks: {},
+                nextChapterApiLink: '/api/bsb/EXO/1.json',
+                nextChapterAudioLinks: {},
+                previousChapterApiLink: null,
+                previousChapterAudioLinks: null,
+                numberOfVerses: 2,
+                chapter: {
+                    number: 1,
+                    content: [
+                        {
+                            type: 'heading',
+                            content: [
+                                'The Creation'
+                            ]
+                        },
+                        {
+                            type: 'line_break'
+                        },
+                        {
+                            type: 'verse',
+                            number: 1,
+                            content: [
+                                'In the beginning God created the heavens and the earth.'
+                            ],
+                        },
+                        {
+                            type: 'line_break'
+                        },
+                        {
+                            type: 'verse',
+                            number: 2,
+                            content: [
+                                'Now the earth was formless and void, and darkness was over the surface of the deep. And the Spirit of God was hovering over the surface of the waters.'
+                            ],
+                        },
+                    ],
+                    footnotes: []
+                }
+            },
+            '/api/bsb/EXO/1.json': {
+                translation: expectedTranslation,
+                book: {
+                    id: 'EXO',
+                    name: 'Exodus',
+                    commonName: 'Exodus',
+                    title: 'Exodus',
+                    order: 2,
+                    numberOfChapters: 1,
+                    totalNumberOfVerses: 2,
+                    firstChapterApiLink: '/api/bsb/EXO/1.json',
+                    lastChapterApiLink: '/api/bsb/EXO/1.json'
+                },
+                thisChapterLink: '/api/bsb/EXO/1.json',
+                thisChapterAudioLinks: {},
+                nextChapterApiLink: null,
+                nextChapterAudioLinks: null,
+                previousChapterApiLink: '/api/bsb/GEN/1.json',
+                previousChapterAudioLinks: {},
+                numberOfVerses: 2,
+                chapter: {
+                    number: 1,
+                    content: [
+                        {
+                            type: 'heading',
+                            content: [
+                                'The Israelites Multiply in Egypt'
+                            ]
+                        },
+                        {
+                            type: 'line_break'
+                        },
+                        {
+                            type: 'verse',
+                            number: 1,
+                            content: [
+                                'These are the names of the sons of Israel who went to Egypt with Jacob, each with his family:'
+                            ],
+                        },
+                        {
+                            type: 'line_break'
+                        },
+                        {
+                            type: 'verse',
+                            number: 2,
+                            content: [
+                                'Reuben, Simeon, Levi, and Judah;'
+                            ],
+                        },
+                    ],
+                    footnotes: []
+                }
+            }
+        });
+        // expect(availableTranslations).toEqual({
+        //     translations: [
+        //         expectedTranslation
+        //     ]
+        // });
+    });
+    it('should use underscores for spaces in the book name', () => {
+        let translation1 = {
+            id: 'bsb',
+            name: 'Berean Standard Bible',
+            englishName: 'Berean Standard Bible',
+            shortName: 'BSB',
+            language: 'eng',
+            direction: 'ltr',
+            licenseUrl: 'https://berean.bible/terms.htm',
+            website: 'https://berean.bible'
+        };
+        let inputFiles = [
+            {
+                fileType: 'usfm',
+                metadata: {
+                    translation: translation1
+                },
+                content: firstXLines(_131CHBSB_usfm_1.default, 11)
+            },
+        ];
+        const dataset = (0, dataset_1.generateDataset)(inputFiles, new linkedom_1.DOMParser());
+        const generated = (0, api_1.generateApiForDataset)(dataset, {
+            useCommonName: true,
+        });
+        const files = (0, api_1.generateFilesForApi)(generated);
+        const tree = fileTree(files);
+        const expectedTranslation = {
+            id: 'bsb',
+            name: 'Berean Standard Bible',
+            englishName: 'Berean Standard Bible',
+            shortName: 'BSB',
+            language: 'eng',
+            textDirection: 'ltr',
+            licenseUrl: 'https://berean.bible/terms.htm',
+            website: 'https://berean.bible',
+            availableFormats: [
+                'json'
+            ],
+            listOfBooksApiLink: '/api/bsb/books.json',
+            numberOfBooks: 1,
+            totalNumberOfChapters: 1,
+            totalNumberOfVerses: 1,
+            languageName: 'English',
+            languageEnglishName: 'English',
+        };
+        expect(tree).toEqual({
+            '/api/available_translations.json': {
+                translations: [
+                    expectedTranslation
+                ]
+            },
+            '/api/bsb/books.json': {
+                translation: expectedTranslation,
+                books: [
+                    {
+                        id: '1CH',
+                        name: '1 Chronicles',
+                        commonName: '1 Chronicles',
+                        title: '1 Chronicles',
+                        numberOfChapters: 1,
+                        totalNumberOfVerses: 1,
+                        order: 13,
+                        firstChapterApiLink: '/api/bsb/1_Chronicles/1.json',
+                        lastChapterApiLink: '/api/bsb/1_Chronicles/1.json',
+                    },
+                ]
+            },
+            '/api/bsb/1_Chronicles/1.json': {
+                translation: expectedTranslation,
+                book: {
+                    id: '1CH',
+                    name: '1 Chronicles',
+                    commonName: '1 Chronicles',
+                    title: '1 Chronicles',
+                    numberOfChapters: 1,
+                    totalNumberOfVerses: 1,
+                    order: 13,
+                    firstChapterApiLink: '/api/bsb/1_Chronicles/1.json',
+                    lastChapterApiLink: '/api/bsb/1_Chronicles/1.json'
+                },
+                thisChapterLink: "/api/bsb/1_Chronicles/1.json",
+                thisChapterAudioLinks: {},
+                nextChapterApiLink: null,
+                nextChapterAudioLinks: null,
+                previousChapterApiLink: null,
+                previousChapterAudioLinks: null,
+                numberOfVerses: 1,
+                chapter: {
+                    number: 1,
+                    content: [
+                        {
+                            type: 'heading',
+                            content: [
+                                'From Adam to Abraham'
+                            ]
+                        },
+                        {
+                            type: 'line_break'
+                        },
+                        {
+                            type: 'verse',
+                            number: 1,
+                            content: [
+                                'Adam, Seth, Enosh,'
+                            ],
+                        },
+                    ],
+                    footnotes: []
+                }
+            },
+        });
+        // expect(availableTranslations).toEqual({
+        //     translations: [
+        //         expectedTranslation
+        //     ]
+        // });
+    });
+    it('produce the correct names for languages', () => {
+        let translation1 = {
+            id: 'bsb',
+            name: 'Berean Standard Bible',
+            englishName: 'Berean Standard Bible',
+            shortName: 'BSB',
+            language: 'spa',
+            direction: 'ltr',
+            licenseUrl: 'https://berean.bible/terms.htm',
+            website: 'https://berean.bible'
+        };
+        let inputFiles = [
+            {
+                fileType: 'usfm',
+                metadata: {
+                    translation: translation1
+                },
+                content: firstXLines(_131CHBSB_usfm_1.default, 11)
+            },
+        ];
+        const dataset = (0, dataset_1.generateDataset)(inputFiles, new linkedom_1.DOMParser());
+        const generated = (0, api_1.generateApiForDataset)(dataset, {
+            useCommonName: true,
+        });
+        const files = (0, api_1.generateFilesForApi)(generated);
+        const tree = fileTree(files);
+        const expectedTranslation = {
+            id: 'bsb',
+            name: 'Berean Standard Bible',
+            englishName: 'Berean Standard Bible',
+            shortName: 'BSB',
+            language: 'spa',
+            textDirection: 'ltr',
+            licenseUrl: 'https://berean.bible/terms.htm',
+            website: 'https://berean.bible',
+            availableFormats: [
+                'json'
+            ],
+            listOfBooksApiLink: '/api/bsb/books.json',
+            numberOfBooks: 1,
+            totalNumberOfChapters: 1,
+            totalNumberOfVerses: 1,
+            languageName: 'español',
+            languageEnglishName: 'Spanish',
+        };
+        expect(tree).toEqual({
+            '/api/available_translations.json': {
+                translations: [
+                    expectedTranslation
+                ]
+            },
+            '/api/bsb/books.json': {
+                translation: expectedTranslation,
+                books: [
+                    {
+                        id: '1CH',
+                        name: '1 Chronicles',
+                        commonName: '1 Chronicles',
+                        title: '1 Chronicles',
+                        numberOfChapters: 1,
+                        totalNumberOfVerses: 1,
+                        order: 13,
+                        firstChapterApiLink: '/api/bsb/1_Chronicles/1.json',
+                        lastChapterApiLink: '/api/bsb/1_Chronicles/1.json',
+                    },
+                ]
+            },
+            '/api/bsb/1_Chronicles/1.json': {
+                translation: expectedTranslation,
+                book: {
+                    id: '1CH',
+                    name: '1 Chronicles',
+                    commonName: '1 Chronicles',
+                    title: '1 Chronicles',
+                    numberOfChapters: 1,
+                    totalNumberOfVerses: 1,
+                    order: 13,
+                    firstChapterApiLink: '/api/bsb/1_Chronicles/1.json',
+                    lastChapterApiLink: '/api/bsb/1_Chronicles/1.json'
+                },
+                thisChapterLink: "/api/bsb/1_Chronicles/1.json",
+                thisChapterAudioLinks: {},
+                nextChapterApiLink: null,
+                nextChapterAudioLinks: null,
+                previousChapterApiLink: null,
+                previousChapterAudioLinks: null,
+                numberOfVerses: 1,
+                chapter: {
+                    number: 1,
+                    content: [
+                        {
+                            type: 'heading',
+                            content: [
+                                'From Adam to Abraham'
+                            ]
+                        },
+                        {
+                            type: 'line_break'
+                        },
+                        {
+                            type: 'verse',
+                            number: 1,
+                            content: [
+                                'Adam, Seth, Enosh,'
+                            ],
+                        },
+                    ],
+                    footnotes: []
+                }
+            },
+        });
+        // expect(availableTranslations).toEqual({
+        //     translations: [
+        //         expectedTranslation
+        //     ]
+        // });
+    });
+});
+function firstXLines(content, x) {
+    const lines = content.split('\n');
+    return lines.slice(0, x).join('\n');
+}
+function fileTree(outputFiles) {
+    let result = {};
+    for (let file of outputFiles) {
+        result[file.path] = file.content;
+    }
+    return result;
+}

package/generation/audio.d.ts

@@ -0,0 +1,20 @@
+import { TranslationBookChapterAudioLinks } from "./common-types";
+type AudioTranslationUrlGenerator = (bookId: string, chapter: number) => string;
+/**
+ * A map of translation IDs to a map of reader IDs to the URL generator for the audio file.
+ */
+export declare const KNOWN_AUDIO_TRANSLATIONS: Map<string, Map<string, AudioTranslationUrlGenerator>>;
+/**
+ * Gets the audio URLs for the given translation, book, and chapter.
+ * @param translationId The ID of the translation.
+ * @param bookId The ID of the book.
+ * @param chapter The number of the chapter.
+ */
+export declare function getAudioUrlsForChapter(translationId: string, bookId: string, chapter: number): TranslationBookChapterAudioLinks;
+/**
+ * Capitalizes the first letter of the given string.
+ * @param str The string to capitalize.
+ */
+export declare function capitalize(str: string): string;
+export {};
+//# sourceMappingURL=audio.d.ts.map

package/generation/audio.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KNOWN_AUDIO_TRANSLATIONS = void 0;
+exports.getAudioUrlsForChapter = getAudioUrlsForChapter;
+exports.capitalize = capitalize;
+const lodash_1 = require("lodash");
+const book_order_1 = require("./book-order");
+const openBibleUrlGenerator = (translation, reader, postfix) => {
+    return (bookId, chapter) => {
+        const bookOrder = (0, lodash_1.padStart)(book_order_1.bookOrderMap.get(bookId).toString(), 2, '0');
+        const chapterStr = (0, lodash_1.padStart)(chapter.toString(), 3, '0');
+        let link = `https://openbible.com/audio/${reader}/${translation}_${bookOrder}_${capitalize(bookId)}_${chapterStr}`;
+        if (postfix) {
+            link += `_${postfix}`;
+        }
+        link += '.mp3';
+        return link;
+    };
+};
+/**
+ * A map of translation IDs to a map of reader IDs to the URL generator for the audio file.
+ */
+exports.KNOWN_AUDIO_TRANSLATIONS = new Map([
+    ['BSB', new Map([
+            ['gilbert', openBibleUrlGenerator('BSB', 'gilbert', 'G')],
+            ['hays', openBibleUrlGenerator('BSB', 'hays', "H")],
+            ['souer', openBibleUrlGenerator('BSB', 'souer', null)],
+        ])],
+]);
+/**
+ * Gets the audio URLs for the given translation, book, and chapter.
+ * @param translationId The ID of the translation.
+ * @param bookId The ID of the book.
+ * @param chapter The number of the chapter.
+ */
+function getAudioUrlsForChapter(translationId, bookId, chapter) {
+    const translation = exports.KNOWN_AUDIO_TRANSLATIONS.get(translationId);
+    if (!translation) {
+        return {};
+    }
+    const links = {};
+    for (let [reader, generator] of translation) {
+        const url = generator(bookId, chapter);
+        if (url) {
+            links[reader] = url;
+        }
+    }
+    return links;
+}
+/**
+ * Capitalizes the first letter of the given string.
+ * @param str The string to capitalize.
+ */
+function capitalize(str) {
+    const char = str.charAt(0);
+    if (/[0-9]/.test(char)) {
+        return str.charAt(0) + str.charAt(1).toUpperCase() + str.slice(2).toLowerCase();
+    }
+    return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
+}

package/generation/audio.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=audio.spec.d.ts.map

package/generation/audio.spec.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const audio_1 = require("./audio");
+describe('capitalize()', () => {
+    const cases = [
+        ['empty', '', ''],
+        ['single letter', 'a', 'A'],
+        ['number', '1abc', '1Abc'],
+        ['word', 'word', 'Word'],
+        ['lowercase rest', 'WORD', 'Word'],
+        ['sentence', 'this is a sentence', 'This is a sentence'],
+    ];
+    it.each(cases)('should capitalize %s', (_desc, input, expected) => {
+        expect((0, audio_1.capitalize)(input)).toBe(expected);
+    });
+});
+describe('KNOWN_AUDIO_TRANSLATIONS', () => {
+    const cases = [
+        // Gilbert
+        ['BSB', 'gilbert', 'GEN', 1, 'https://openbible.com/audio/gilbert/BSB_01_Gen_001_G.mp3'],
+        ['BSB', 'gilbert', '1SA', 5, 'https://openbible.com/audio/gilbert/BSB_09_1Sa_005_G.mp3'],
+        ['BSB', 'gilbert', 'PSA', 110, 'https://openbible.com/audio/gilbert/BSB_19_Psa_110_G.mp3'],
+        // Hays
+        ['BSB', 'hays', 'GEN', 1, 'https://openbible.com/audio/hays/BSB_01_Gen_001_H.mp3'],
+        ['BSB', 'hays', '1SA', 5, 'https://openbible.com/audio/hays/BSB_09_1Sa_005_H.mp3'],
+        ['BSB', 'hays', 'PSA', 110, 'https://openbible.com/audio/hays/BSB_19_Psa_110_H.mp3'],
+        // Souer
+        ['BSB', 'souer', 'GEN', 1, 'https://openbible.com/audio/souer/BSB_01_Gen_001.mp3'],
+        ['BSB', 'souer', '1SA', 5, 'https://openbible.com/audio/souer/BSB_09_1Sa_005.mp3'],
+        ['BSB', 'souer', 'PSA', 110, 'https://openbible.com/audio/souer/BSB_19_Psa_110.mp3'],
+    ];
+    it.each(cases)('should generate the correct URL for %s %s %s', (translationId, reader, bookId, chapter, expected) => {
+        const generator = audio_1.KNOWN_AUDIO_TRANSLATIONS.get(translationId).get(reader);
+        expect(generator(bookId, chapter)).toBe(expected);
+    });
+});

package/generation/book-order.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Defines a map that maps the book ID to the numerical order of the book.
+ */
+export declare const bookOrderMap: Map<string, number>;
+/**
+ * Defines a map that maps the book ID to the number of chapters the book has.
+ */
+export declare const bookChapterCountMap: Map<string, number>;
+/**
+ * Defines a map that maps a locale ID to a book name map.
+ */
+export declare const bookIdMap: Map<string, Map<string, {
+    commonName: string;
+}>>;
+//# sourceMappingURL=book-order.d.ts.map