@helloao/tools 0.0.4 → 0.0.6-alpha

package/README.md

@@ -16,6 +16,7 @@ $ npm install @helloao/tools
 ### Usage
 
 #### Parse a USX File
+
 ```typescript
 import { parser } from '@helloao/tools';
 // Used to parse XML
@@ -36,7 +37,6 @@ const domParser = new DOMParser();
 // Each input file needs some metadata about the translation that it is associated with
 const translation: generation.ParseTreeMetadata = {
     translation: {
-
         // The ID of the translation
         // this should be unique for the translation
         id: 'my translation id',
@@ -60,7 +60,7 @@ const translation: generation.ParseTreeMetadata = {
         // The direction that the text is written in.
         // "ltr" means "left to right" and "rtl" means "right to left"
         direction: 'ltr',
-    }
+    },
 };
 
 // The list of files that should be processed.
@@ -74,14 +74,14 @@ const files: generation.InputFile[] = [
 
         // The type of the file.
         // One of "usx", "usfm", and "json"
-        fileType: 'usx'
-    }
+        fileType: 'usx',
+    },
 ];
 
 // Generate a dataset from the files
 // Datasets organize all the files and their content
 // by translation, book, chapter, and verse
-const dataset = generation.dataset.generateDataset(files, parser);
+const dataset = generation.dataset.generateDataset(files, domParser);
 
 // Generate an API representation from the files
 // This adds links between chapters and additional metadata.
@@ -95,4 +95,4 @@ const outputFiles = generation.api.generateFilesForApi(api);
 for (let file of outputFiles) {
     console.log(file.path, file.content);
 }
-```
+```

package/dist/cjs/generation/api.cjs

@@ -0,0 +1,240 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var api_exports = {};
+__export(api_exports, {
+  bookChapterApiLink: () => bookChapterApiLink,
+  bookChapterAudioApiLink: () => bookChapterAudioApiLink,
+  downloadedFile: () => downloadedFile,
+  generateApiForDataset: () => generateApiForDataset,
+  generateFilesForApi: () => generateFilesForApi,
+  generateOutputFilesFromDatasets: () => generateOutputFilesFromDatasets,
+  jsonFile: () => jsonFile,
+  listOfBooksApiLink: () => listOfBooksApiLink,
+  replaceSpacesWithUnderscores: () => replaceSpacesWithUnderscores
+});
+module.exports = __toCommonJS(api_exports);
+function generateApiForDataset(dataset, options = {}) {
+  const { useCommonName, pathPrefix } = options;
+  const apiPathPrefix = pathPrefix ? pathPrefix : "";
+  let api = {
+    availableTranslations: {
+      translations: []
+    },
+    translationBooks: [],
+    translationBookChapters: [],
+    translationBookChapterAudio: [],
+    pathPrefix: apiPathPrefix
+  };
+  const getNativeName = options.getNativeName;
+  const getEnglishName = options.getEnglishName;
+  for (let { books, ...translation } of dataset.translations) {
+    const apiTranslation = {
+      ...translation,
+      availableFormats: ["json"],
+      listOfBooksApiLink: listOfBooksApiLink(
+        translation.id,
+        apiPathPrefix
+      ),
+      numberOfBooks: books.length,
+      totalNumberOfChapters: 0,
+      totalNumberOfVerses: 0,
+      languageName: getNativeName ? getNativeName(translation.language) ?? void 0 : void 0,
+      languageEnglishName: getEnglishName ? getEnglishName(translation.language) ?? void 0 : void 0
+    };
+    const translationBooks = {
+      translation: apiTranslation,
+      books: []
+    };
+    let translationChapters = [];
+    for (let { chapters, ...book } of books) {
+      const apiBook = {
+        ...book,
+        firstChapterApiLink: bookChapterApiLink(
+          translation.id,
+          getBookLink(book),
+          1,
+          "json",
+          apiPathPrefix
+        ),
+        lastChapterApiLink: bookChapterApiLink(
+          translation.id,
+          getBookLink(book),
+          chapters.length,
+          "json",
+          apiPathPrefix
+        ),
+        numberOfChapters: chapters.length,
+        totalNumberOfVerses: 0
+      };
+      for (let { chapter, thisChapterAudioLinks } of chapters) {
+        const audio = {};
+        const apiBookChapter = {
+          translation: apiTranslation,
+          book: apiBook,
+          chapter,
+          thisChapterLink: bookChapterApiLink(
+            translation.id,
+            getBookLink(book),
+            chapter.number,
+            "json",
+            apiPathPrefix
+          ),
+          thisChapterAudioLinks: audio,
+          nextChapterApiLink: null,
+          nextChapterAudioLinks: null,
+          previousChapterApiLink: null,
+          previousChapterAudioLinks: null,
+          numberOfVerses: 0
+        };
+        for (let reader in thisChapterAudioLinks) {
+          if (options.generateAudioFiles) {
+            const apiAudio = {
+              chapter: apiBookChapter,
+              link: bookChapterAudioApiLink(
+                translation.id,
+                getBookLink(book),
+                chapter.number,
+                reader,
+                apiPathPrefix
+              ),
+              originalUrl: thisChapterAudioLinks[reader]
+            };
+            audio[reader] = apiAudio.link;
+            api.translationBookChapterAudio.push(apiAudio);
+          } else {
+            audio[reader] = thisChapterAudioLinks[reader];
+          }
+        }
+        for (let c of chapter.content) {
+          if (c.type === "verse") {
+            apiBookChapter.numberOfVerses++;
+          }
+        }
+        apiBook.totalNumberOfVerses += apiBookChapter.numberOfVerses;
+        translationChapters.push(apiBookChapter);
+        api.translationBookChapters.push(apiBookChapter);
+      }
+      translationBooks.books.push(apiBook);
+      apiTranslation.totalNumberOfChapters += apiBook.numberOfChapters;
+      apiTranslation.totalNumberOfVerses += apiBook.totalNumberOfVerses;
+    }
+    for (let i = 0; i < translationChapters.length; i++) {
+      if (i > 0) {
+        translationChapters[i].previousChapterApiLink = bookChapterApiLink(
+          translation.id,
+          getBookLink(translationChapters[i - 1].book),
+          translationChapters[i - 1].chapter.number,
+          "json",
+          apiPathPrefix
+        );
+        translationChapters[i].previousChapterAudioLinks = translationChapters[i - 1].thisChapterAudioLinks;
+      }
+      if (i < translationChapters.length - 1) {
+        translationChapters[i].nextChapterApiLink = bookChapterApiLink(
+          translation.id,
+          getBookLink(translationChapters[i + 1].book),
+          translationChapters[i + 1].chapter.number,
+          "json",
+          apiPathPrefix
+        );
+        translationChapters[i].nextChapterAudioLinks = translationChapters[i + 1].thisChapterAudioLinks;
+      }
+    }
+    api.availableTranslations.translations.push(apiTranslation);
+    api.translationBooks.push(translationBooks);
+  }
+  return api;
+  function getBookLink(book) {
+    return useCommonName ? book.commonName : book.id;
+  }
+}
+function generateFilesForApi(api) {
+  let files = [];
+  files.push(
+    jsonFile(
+      `${api.pathPrefix}/api/available_translations.json`,
+      api.availableTranslations,
+      true
+    )
+  );
+  for (let translationBooks of api.translationBooks) {
+    files.push(
+      jsonFile(
+        translationBooks.translation.listOfBooksApiLink,
+        translationBooks
+      )
+    );
+  }
+  for (let bookChapter of api.translationBookChapters) {
+    files.push(jsonFile(bookChapter.thisChapterLink, bookChapter));
+  }
+  for (let audio of api.translationBookChapterAudio) {
+    files.push(downloadedFile(audio.link, audio.originalUrl));
+  }
+  return files;
+}
+async function* generateOutputFilesFromDatasets(datasets, options) {
+  for await (let dataset of datasets) {
+    const api = generateApiForDataset(dataset, options);
+    const files = generateFilesForApi(api);
+    yield files;
+  }
+}
+function listOfBooksApiLink(translationId, prefix = "") {
+  return `${prefix}/api/${translationId}/books.json`;
+}
+function bookChapterApiLink(translationId, commonName, chapterNumber, extension, prefix = "") {
+  return `${prefix}/api/${translationId}/${replaceSpacesWithUnderscores(
+    commonName
+  )}/${chapterNumber}.${extension}`;
+}
+function bookChapterAudioApiLink(translationId, bookId, chapterNumber, reader, prefix = "") {
+  return `${prefix}/api/${translationId}/${replaceSpacesWithUnderscores(
+    bookId
+  )}/${chapterNumber}.${reader}.mp3`;
+}
+function jsonFile(path, content, mergable) {
+  return {
+    path,
+    content,
+    mergable
+  };
+}
+function downloadedFile(path, url) {
+  return {
+    path,
+    content: () => fetch(url).then((response) => response.body)
+  };
+}
+function replaceSpacesWithUnderscores(str) {
+  return str.replace(/[<>:"/\\|?*\s]/g, "_");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  bookChapterApiLink,
+  bookChapterAudioApiLink,
+  downloadedFile,
+  generateApiForDataset,
+  generateFilesForApi,
+  generateOutputFilesFromDatasets,
+  jsonFile,
+  listOfBooksApiLink,
+  replaceSpacesWithUnderscores
+});
+//# sourceMappingURL=api.cjs.map

package/dist/cjs/generation/api.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../generation/api.ts"],
+  "sourcesContent": ["import {\n    OutputFile,\n    Translation,\n    TranslationBook,\n    TranslationBookChapter,\n    TranslationBookChapterAudioLinks,\n} from './common-types.js';\nimport { DatasetOutput } from './dataset.js';\n\n/**\n * Defines the output of the API generation.\n */\nexport interface ApiOutput {\n    /**\n     * The list of available translations.\n     * This maps to the /api/available-translations.json endpoint.\n     */\n    availableTranslations: ApiAvailableTranslations;\n\n    /**\n     * The list of books for each translation.\n     * This maps to the /api/:translationId/books.json endpoint.\n     */\n    translationBooks: ApiTranslationBooks[];\n\n    /**\n     * The list of chapters for each book.\n     * This maps to the following endpoints:\n     * - /api/:translationId/:bookId/:chapterNumber.json\n     * - /api/:translationId/:bookCommonName/:chapterNumber.json\n     */\n    translationBookChapters: ApiTranslationBookChapter[];\n\n    /**\n     * The list of audio files.\n     * This maps to the following endpoints:\n     * - /api/:translationId/:bookId/:chapterNumber.:reader.mp3\n     */\n    translationBookChapterAudio: ApiTranslationBookChapterAudio[];\n\n    /**\n     * The path prefix that the API should use.\n     */\n    pathPrefix: string;\n}\n\n/**\n * The list of available translations.\n * Maps to the /api/available-translations.json endpoint.\n */\nexport interface ApiAvailableTranslations {\n    /**\n     * The list of translations.\n     */\n    translations: ApiTranslation[];\n}\n\n/**\n * Defines a translation that is used in the API.\n */\nexport interface ApiTranslation extends Translation {\n    /**\n     * The API link for the list of available books for this translation.\n     */\n    listOfBooksApiLink: string;\n\n    /**\n     * The available list of formats.\n     */\n    availableFormats: ('json' | 'usfm')[];\n\n    /**\n     * The number of books that are contained in this translation.\n     *\n     * Complete translations should have the same number of books as the Bible (66).\n     */\n    numberOfBooks: number;\n\n    /**\n     * The total number of chapters that are contained in this translation.\n     *\n     * Complete translations should have the same number of chapters as the Bible (1,189).\n     */\n    totalNumberOfChapters: number;\n\n    /**\n     * The total number of verses that are contained in this translation.\n     *\n     * Complete translations should have the same number of verses as the Bible (around 31,102 - some translations exclude verses based on the aparent likelyhood of existing in the original source texts).\n     */\n    totalNumberOfVerses: number;\n\n    /**\n     * Gets the name of the language that the translation is in.\n     * Null or undefined if the name of the language is not known.\n     */\n    languageName?: string;\n\n    /**\n     * Gets the name of the language in English.\n     * Null or undefined if the language doesn't have an english name.\n     */\n    languageEnglishName?: string;\n}\n\n/**\n * Defines an interface that contains information about the books that are available for a translation.\n */\nexport interface ApiTranslationBooks {\n    /**\n     * The translation information for the books.\n     */\n    translation: ApiTranslation;\n\n    /**\n     * The list of books that are available for the translation.\n     */\n    books: ApiTranslationBook[];\n}\n\n/**\n * Defines a translation book that is used in the API.\n */\nexport interface ApiTranslationBook extends TranslationBook {\n    /**\n     * The link to the first chapter of the book.\n     */\n    firstChapterApiLink: string;\n\n    /**\n     * The link to the last chapter of the book.\n     */\n    lastChapterApiLink: string;\n\n    /**\n     * The number of chapters that the book contains.\n     */\n    numberOfChapters: number;\n\n    /**\n     * The number of verses that the book contains.\n     */\n    totalNumberOfVerses: number;\n}\n\n/**\n * Defines an interface that contains information about a book chapter.\n */\nexport interface ApiTranslationBookChapter extends TranslationBookChapter {\n    /**\n     * The translation information for the book chapter.\n     */\n    translation: ApiTranslation;\n\n    /**\n     * The book information for the book chapter.\n     */\n    book: ApiTranslationBook;\n\n    /**\n     * The link to this chapter.\n     */\n    thisChapterLink: string;\n\n    /**\n     * The link to the next chapter.\n     * Null if this is the last chapter in the translation.\n     */\n    nextChapterApiLink: string | null;\n\n    /**\n     * The links to the audio versions for the next chapter.\n     * Null if this is the last chapter in the translation.\n     */\n    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;\n\n    /**\n     * The link to the previous chapter.\n     * Null if this is the first chapter in the translation.\n     */\n    previousChapterApiLink: string | null;\n\n    /**\n     * The links to the audio versions for the previous chapter.\n     * Null if this is the first chapter in the translation.\n     */\n    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;\n\n    /**\n     * The number of verses that the chapter contains.\n     */\n    numberOfVerses: number;\n}\n\nexport interface ApiTranslationBookChapterAudio {\n    /**\n     * The chapter that the audio is for.\n     */\n    chapter: ApiTranslationBookChapter;\n\n    /**\n     * The link that the audio should be placed at.\n     */\n    link: string;\n\n    /**\n     * The original URL of the audio.\n     */\n    originalUrl: string;\n}\n\n/**\n * The options for generating the API.\n */\nexport interface GenerateApiOptions {\n    /**\n     * Whether to use the common name for the book chapter API link. If false, then book IDs are used.\n     * Audio URLs will always use the book ID.\n     * Defaults to false.\n     */\n    useCommonName?: boolean;\n\n    /**\n     * Whether to replace the audio URLs in the dataset with ones that are hosted locally.\n     * If true, then the audio URLs in the dataset will be replaced with ones that reference files hosted by the API itself.\n     * If false, then the audio URLs in the dataset will be left as is.\n     * Defaults to false.\n     */\n    generateAudioFiles?: boolean;\n\n    /**\n     * Gets the english name of the given language.\n     * If not provided, then the english name for the language will be unknown and omitted.\n     * @param language The language to get the english name for.\n     */\n    getEnglishName?: (language: string) => string | null | undefined;\n\n    /**\n     * Gets the native name of the given language.\n     * If not provided, then the native name for the language will be unknown and omitted.\n     * @param language The language to get the native name for.\n     */\n    getNativeName?: (language: string) => string | null | undefined;\n\n    /**\n     * The prefix that should be added to paths that are generated.\n     */\n    pathPrefix?: string;\n}\n\n/**\n * Generates the API output for the given dataset.\n * @param dataset The dataset to generate the API for.\n * @param options The options for generating the API.\n */\nexport function generateApiForDataset(\n    dataset: DatasetOutput,\n    options: GenerateApiOptions = {}\n): ApiOutput {\n    const { useCommonName, pathPrefix } = options;\n    const apiPathPrefix = pathPrefix ? pathPrefix : '';\n    let api: ApiOutput = {\n        availableTranslations: {\n            translations: [],\n        },\n        translationBooks: [],\n        translationBookChapters: [],\n        translationBookChapterAudio: [],\n        pathPrefix: apiPathPrefix,\n    };\n\n    const getNativeName = options.getNativeName;\n    const getEnglishName = options.getEnglishName;\n\n    for (let { books, ...translation } of dataset.translations) {\n        const apiTranslation: ApiTranslation = {\n            ...translation,\n            availableFormats: ['json'],\n            listOfBooksApiLink: listOfBooksApiLink(\n                translation.id,\n                apiPathPrefix\n            ),\n            numberOfBooks: books.length,\n            totalNumberOfChapters: 0,\n            totalNumberOfVerses: 0,\n            languageName: getNativeName\n                ? getNativeName(translation.language) ?? undefined\n                : undefined,\n            languageEnglishName: getEnglishName\n                ? getEnglishName(translation.language) ?? undefined\n                : undefined,\n        };\n\n        const translationBooks: ApiTranslationBooks = {\n            translation: apiTranslation,\n            books: [],\n        };\n\n        let translationChapters: ApiTranslationBookChapter[] = [];\n\n        for (let { chapters, ...book } of books) {\n            const apiBook: ApiTranslationBook = {\n                ...book,\n                firstChapterApiLink: bookChapterApiLink(\n                    translation.id,\n                    getBookLink(book),\n                    1,\n                    'json',\n                    apiPathPrefix\n                ),\n                lastChapterApiLink: bookChapterApiLink(\n                    translation.id,\n                    getBookLink(book),\n                    chapters.length,\n                    'json',\n                    apiPathPrefix\n                ),\n                numberOfChapters: chapters.length,\n                totalNumberOfVerses: 0,\n            };\n\n            for (let { chapter, thisChapterAudioLinks } of chapters) {\n                const audio: TranslationBookChapterAudioLinks = {};\n                const apiBookChapter: ApiTranslationBookChapter = {\n                    translation: apiTranslation,\n                    book: apiBook,\n                    chapter: chapter,\n                    thisChapterLink: bookChapterApiLink(\n                        translation.id,\n                        getBookLink(book),\n                        chapter.number,\n                        'json',\n                        apiPathPrefix\n                    ),\n                    thisChapterAudioLinks: audio,\n                    nextChapterApiLink: null,\n                    nextChapterAudioLinks: null,\n                    previousChapterApiLink: null,\n                    previousChapterAudioLinks: null,\n                    numberOfVerses: 0,\n                };\n\n                for (let reader in thisChapterAudioLinks) {\n                    if (options.generateAudioFiles) {\n                        const apiAudio: ApiTranslationBookChapterAudio = {\n                            chapter: apiBookChapter,\n                            link: bookChapterAudioApiLink(\n                                translation.id,\n                                getBookLink(book),\n                                chapter.number,\n                                reader,\n                                apiPathPrefix\n                            ),\n                            originalUrl: thisChapterAudioLinks[reader],\n                        };\n                        audio[reader] = apiAudio.link;\n                        api.translationBookChapterAudio.push(apiAudio);\n                    } else {\n                        audio[reader] = thisChapterAudioLinks[reader];\n                    }\n                }\n\n                for (let c of chapter.content) {\n                    if (c.type === 'verse') {\n                        apiBookChapter.numberOfVerses++;\n                    }\n                }\n\n                apiBook.totalNumberOfVerses += apiBookChapter.numberOfVerses;\n\n                translationChapters.push(apiBookChapter);\n                api.translationBookChapters.push(apiBookChapter);\n            }\n\n            translationBooks.books.push(apiBook);\n\n            apiTranslation.totalNumberOfChapters += apiBook.numberOfChapters;\n            apiTranslation.totalNumberOfVerses += apiBook.totalNumberOfVerses;\n        }\n\n        for (let i = 0; i < translationChapters.length; i++) {\n            if (i > 0) {\n                translationChapters[i].previousChapterApiLink =\n                    bookChapterApiLink(\n                        translation.id,\n                        getBookLink(translationChapters[i - 1].book),\n                        translationChapters[i - 1].chapter.number,\n                        'json',\n                        apiPathPrefix\n                    );\n                translationChapters[i].previousChapterAudioLinks =\n                    translationChapters[i - 1].thisChapterAudioLinks;\n            }\n\n            if (i < translationChapters.length - 1) {\n                translationChapters[i].nextChapterApiLink = bookChapterApiLink(\n                    translation.id,\n                    getBookLink(translationChapters[i + 1].book),\n                    translationChapters[i + 1].chapter.number,\n                    'json',\n                    apiPathPrefix\n                );\n                translationChapters[i].nextChapterAudioLinks =\n                    translationChapters[i + 1].thisChapterAudioLinks;\n            }\n        }\n\n        api.availableTranslations.translations.push(apiTranslation);\n        api.translationBooks.push(translationBooks);\n    }\n\n    return api;\n\n    function getBookLink(book: TranslationBook): string {\n        return useCommonName ? book.commonName : book.id;\n    }\n}\n\n/**\n * Generates the output files for the given API.\n * @param api The API that the files should be generated for.\n */\nexport function generateFilesForApi(api: ApiOutput): OutputFile[] {\n    let files: OutputFile[] = [];\n\n    files.push(\n        jsonFile(\n            `${api.pathPrefix}/api/available_translations.json`,\n            api.availableTranslations,\n            true\n        )\n    );\n    for (let translationBooks of api.translationBooks) {\n        files.push(\n            jsonFile(\n                translationBooks.translation.listOfBooksApiLink,\n                translationBooks\n            )\n        );\n    }\n\n    for (let bookChapter of api.translationBookChapters) {\n        files.push(jsonFile(bookChapter.thisChapterLink, bookChapter));\n    }\n\n    for (let audio of api.translationBookChapterAudio) {\n        files.push(downloadedFile(audio.link, audio.originalUrl));\n    }\n\n    return files;\n}\n\n/**\n * Generates the output files for the given datasets.\n * @param datasets The datasets to generate the output files for.\n * @param options The options for generating the API files.\n */\nexport async function* generateOutputFilesFromDatasets(\n    datasets: AsyncIterable<DatasetOutput>,\n    options?: GenerateApiOptions\n): AsyncGenerator<OutputFile[]> {\n    for await (let dataset of datasets) {\n        const api = generateApiForDataset(dataset, options);\n        const files = generateFilesForApi(api);\n\n        yield files;\n    }\n}\n\n/**\n * Gets the API Link for the list of books endpoint for a translation.\n * @param translationId The ID of the translation.\n * @returns\n */\nexport function listOfBooksApiLink(\n    translationId: string,\n    prefix: string = ''\n): string {\n    return `${prefix}/api/${translationId}/books.json`;\n}\n\n/**\n * Getes the API link for a book chapter.\n * @param translationId The ID of the translation.\n * @param commonName The name of the book.\n * @param chapterNumber The number of the book.\n * @param extension The extension of the file.\n */\nexport function bookChapterApiLink(\n    translationId: string,\n    commonName: string,\n    chapterNumber: number,\n    extension: string,\n    prefix: string = ''\n) {\n    return `${prefix}/api/${translationId}/${replaceSpacesWithUnderscores(\n        commonName\n    )}/${chapterNumber}.${extension}`;\n}\n\nexport function bookChapterAudioApiLink(\n    translationId: string,\n    bookId: string,\n    chapterNumber: number,\n    reader: string,\n    prefix: string = ''\n) {\n    return `${prefix}/api/${translationId}/${replaceSpacesWithUnderscores(\n        bookId\n    )}/${chapterNumber}.${reader}.mp3`;\n}\n\nexport function jsonFile(\n    path: string,\n    content: any,\n    mergable?: boolean\n): OutputFile {\n    return {\n        path,\n        content,\n        mergable,\n    };\n}\n\nexport function downloadedFile(path: string, url: string): OutputFile {\n    return {\n        path,\n        content: () => fetch(url).then((response) => response.body),\n    };\n}\n\nexport function replaceSpacesWithUnderscores(str: string): string {\n    return str.replace(/[<>:\"/\\\\|?*\\s]/g, '_');\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA+PO,SAAS,sBACZ,SACA,UAA8B,CAAC,GACtB;AACT,QAAM,EAAE,eAAe,WAAW,IAAI;AACtC,QAAM,gBAAgB,aAAa,aAAa;AAChD,MAAI,MAAiB;AAAA,IACjB,uBAAuB;AAAA,MACnB,cAAc,CAAC;AAAA,IACnB;AAAA,IACA,kBAAkB,CAAC;AAAA,IACnB,yBAAyB,CAAC;AAAA,IAC1B,6BAA6B,CAAC;AAAA,IAC9B,YAAY;AAAA,EAChB;AAEA,QAAM,gBAAgB,QAAQ;AAC9B,QAAM,iBAAiB,QAAQ;AAE/B,WAAS,EAAE,OAAO,GAAG,YAAY,KAAK,QAAQ,cAAc;AACxD,UAAM,iBAAiC;AAAA,MACnC,GAAG;AAAA,MACH,kBAAkB,CAAC,MAAM;AAAA,MACzB,oBAAoB;AAAA,QAChB,YAAY;AAAA,QACZ;AAAA,MACJ;AAAA,MACA,eAAe,MAAM;AAAA,MACrB,uBAAuB;AAAA,MACvB,qBAAqB;AAAA,MACrB,cAAc,gBACR,cAAc,YAAY,QAAQ,KAAK,SACvC;AAAA,MACN,qBAAqB,iBACf,eAAe,YAAY,QAAQ,KAAK,SACxC;AAAA,IACV;AAEA,UAAM,mBAAwC;AAAA,MAC1C,aAAa;AAAA,MACb,OAAO,CAAC;AAAA,IACZ;AAEA,QAAI,sBAAmD,CAAC;AAExD,aAAS,EAAE,UAAU,GAAG,KAAK,KAAK,OAAO;AACrC,YAAM,UAA8B;AAAA,QAChC,GAAG;AAAA,QACH,qBAAqB;AAAA,UACjB,YAAY;AAAA,UACZ,YAAY,IAAI;AAAA,UAChB;AAAA,UACA;AAAA,UACA;AAAA,QACJ;AAAA,QACA,oBAAoB;AAAA,UAChB,YAAY;AAAA,UACZ,YAAY,IAAI;AAAA,UAChB,SAAS;AAAA,UACT;AAAA,UACA;AAAA,QACJ;AAAA,QACA,kBAAkB,SAAS;AAAA,QAC3B,qBAAqB;AAAA,MACzB;AAEA,eAAS,EAAE,SAAS,sBAAsB,KAAK,UAAU;AACrD,cAAM,QAA0C,CAAC;AACjD,cAAM,iBAA4C;AAAA,UAC9C,aAAa;AAAA,UACb,MAAM;AAAA,UACN;AAAA,UACA,iBAAiB;AAAA,YACb,YAAY;AAAA,YACZ,YAAY,IAAI;AAAA,YAChB,QAAQ;AAAA,YACR;AAAA,YACA;AAAA,UACJ;AAAA,UACA,uBAAuB;AAAA,UACvB,oBAAoB;AAAA,UACpB,uBAAuB;AAAA,UACvB,wBAAwB;AAAA,UACxB,2BAA2B;AAAA,UAC3B,gBAAgB;AAAA,QACpB;AAEA,iBAAS,UAAU,uBAAuB;AACtC,cAAI,QAAQ,oBAAoB;AAC5B,kBAAM,WAA2C;AAAA,cAC7C,SAAS;AAAA,cACT,MAAM;AAAA,gBACF,YAAY;AAAA,gBACZ,YAAY,IAAI;AAAA,gBAChB,QAAQ;AAAA,gBACR;AAAA,gBACA;AAAA,cACJ;AAAA,cACA,aAAa,sBAAsB,MAAM;AAAA,YAC7C;AACA,kBAAM,MAAM,IAAI,SAAS;AACzB,gBAAI,4BAA4B,KAAK,QAAQ;AAAA,UACjD,OAAO;AACH,kBAAM,MAAM,IAAI,sBAAsB,MAAM;AAAA,UAChD;AAAA,QACJ;AAEA,iBAAS,KAAK,QAAQ,SAAS;AAC3B,cAAI,EAAE,SAAS,SAAS;AACpB,2BAAe;AAAA,UACnB;AAAA,QACJ;AAEA,gBAAQ,uBAAuB,eAAe;AAE9C,4BAAoB,KAAK,cAAc;AACvC,YAAI,wBAAwB,KAAK,cAAc;AAAA,MACnD;AAEA,uBAAiB,MAAM,KAAK,OAAO;AAEnC,qBAAe,yBAAyB,QAAQ;AAChD,qBAAe,uBAAuB,QAAQ;AAAA,IAClD;AAEA,aAAS,IAAI,GAAG,IAAI,oBAAoB,QAAQ,KAAK;AACjD,UAAI,IAAI,GAAG;AACP,4BAAoB,CAAC,EAAE,yBACnB;AAAA,UACI,YAAY;AAAA,UACZ,YAAY,oBAAoB,IAAI,CAAC,EAAE,IAAI;AAAA,UAC3C,oBAAoB,IAAI,CAAC,EAAE,QAAQ;AAAA,UACnC;AAAA,UACA;AAAA,QACJ;AACJ,4BAAoB,CAAC,EAAE,4BACnB,oBAAoB,IAAI,CAAC,EAAE;AAAA,MACnC;AAEA,UAAI,IAAI,oBAAoB,SAAS,GAAG;AACpC,4BAAoB,CAAC,EAAE,qBAAqB;AAAA,UACxC,YAAY;AAAA,UACZ,YAAY,oBAAoB,IAAI,CAAC,EAAE,IAAI;AAAA,UAC3C,oBAAoB,IAAI,CAAC,EAAE,QAAQ;AAAA,UACnC;AAAA,UACA;AAAA,QACJ;AACA,4BAAoB,CAAC,EAAE,wBACnB,oBAAoB,IAAI,CAAC,EAAE;AAAA,MACnC;AAAA,IACJ;AAEA,QAAI,sBAAsB,aAAa,KAAK,cAAc;AAC1D,QAAI,iBAAiB,KAAK,gBAAgB;AAAA,EAC9C;AAEA,SAAO;AAEP,WAAS,YAAY,MAA+B;AAChD,WAAO,gBAAgB,KAAK,aAAa,KAAK;AAAA,EAClD;AACJ;AAMO,SAAS,oBAAoB,KAA8B;AAC9D,MAAI,QAAsB,CAAC;AAE3B,QAAM;AAAA,IACF;AAAA,MACI,GAAG,IAAI,UAAU;AAAA,MACjB,IAAI;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACA,WAAS,oBAAoB,IAAI,kBAAkB;AAC/C,UAAM;AAAA,MACF;AAAA,QACI,iBAAiB,YAAY;AAAA,QAC7B;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,WAAS,eAAe,IAAI,yBAAyB;AACjD,UAAM,KAAK,SAAS,YAAY,iBAAiB,WAAW,CAAC;AAAA,EACjE;AAEA,WAAS,SAAS,IAAI,6BAA6B;AAC/C,UAAM,KAAK,eAAe,MAAM,MAAM,MAAM,WAAW,CAAC;AAAA,EAC5D;AAEA,SAAO;AACX;AAOA,gBAAuB,gCACnB,UACA,SAC4B;AAC5B,iBAAe,WAAW,UAAU;AAChC,UAAM,MAAM,sBAAsB,SAAS,OAAO;AAClD,UAAM,QAAQ,oBAAoB,GAAG;AAErC,UAAM;AAAA,EACV;AACJ;AAOO,SAAS,mBACZ,eACA,SAAiB,IACX;AACN,SAAO,GAAG,MAAM,QAAQ,aAAa;AACzC;AASO,SAAS,mBACZ,eACA,YACA,eACA,WACA,SAAiB,IACnB;AACE,SAAO,GAAG,MAAM,QAAQ,aAAa,IAAI;AAAA,IACrC;AAAA,EACJ,CAAC,IAAI,aAAa,IAAI,SAAS;AACnC;AAEO,SAAS,wBACZ,eACA,QACA,eACA,QACA,SAAiB,IACnB;AACE,SAAO,GAAG,MAAM,QAAQ,aAAa,IAAI;AAAA,IACrC;AAAA,EACJ,CAAC,IAAI,aAAa,IAAI,MAAM;AAChC;AAEO,SAAS,SACZ,MACA,SACA,UACU;AACV,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AACJ;AAEO,SAAS,eAAe,MAAc,KAAyB;AAClE,SAAO;AAAA,IACH;AAAA,IACA,SAAS,MAAM,MAAM,GAAG,EAAE,KAAK,CAAC,aAAa,SAAS,IAAI;AAAA,EAC9D;AACJ;AAEO,SAAS,6BAA6B,KAAqB;AAC9D,SAAO,IAAI,QAAQ,mBAAmB,GAAG;AAC7C;",
+  "names": []
+}

package/dist/cjs/generation/audio.cjs

@@ -0,0 +1,83 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var audio_exports = {};
+__export(audio_exports, {
+  KNOWN_AUDIO_TRANSLATIONS: () => KNOWN_AUDIO_TRANSLATIONS,
+  capitalize: () => capitalize,
+  getAudioUrlsForChapter: () => getAudioUrlsForChapter
+});
+module.exports = __toCommonJS(audio_exports);
+var import_lodash = require("lodash");
+var import_book_order = require("./book-order.js");
+const openBibleUrlGenerator = (translation, reader, postfix) => {
+  return (bookId, chapter) => {
+    const bookOrder = (0, import_lodash.padStart)(
+      import_book_order.bookOrderMap.get(bookId).toString(),
+      2,
+      "0"
+    );
+    const chapterStr = (0, import_lodash.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;
+  };
+};
+const KNOWN_AUDIO_TRANSLATIONS = /* @__PURE__ */ new Map([
+  [
+    "BSB",
+    /* @__PURE__ */ new Map([
+      ["gilbert", openBibleUrlGenerator("BSB", "gilbert", "G")],
+      ["hays", openBibleUrlGenerator("BSB", "hays", "H")],
+      ["souer", openBibleUrlGenerator("BSB", "souer", null)]
+    ])
+  ]
+]);
+function getAudioUrlsForChapter(translationId, bookId, chapter) {
+  const translation = 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;
+}
+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();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  KNOWN_AUDIO_TRANSLATIONS,
+  capitalize,
+  getAudioUrlsForChapter
+});
+//# sourceMappingURL=audio.cjs.map

package/dist/cjs/generation/audio.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../generation/audio.ts"],
+  "sourcesContent": ["import { padStart } from 'lodash';\nimport { bookOrderMap } from './book-order.js';\nimport { TranslationBookChapterAudioLinks } from './common-types.js';\n\ntype AudioTranslationUrlGenerator = (bookId: string, chapter: number) => string;\n\nconst openBibleUrlGenerator: (\n    translation: string,\n    reader: string,\n    postfix: string | null\n) => AudioTranslationUrlGenerator = (translation, reader, postfix) => {\n    return (bookId, chapter) => {\n        const bookOrder = padStart(\n            bookOrderMap.get(bookId)!.toString(),\n            2,\n            '0'\n        );\n        const chapterStr = padStart(chapter.toString(), 3, '0');\n\n        let link = `https://openbible.com/audio/${reader}/${translation}_${bookOrder}_${capitalize(\n            bookId\n        )}_${chapterStr}`;\n\n        if (postfix) {\n            link += `_${postfix}`;\n        }\n\n        link += '.mp3';\n\n        return link;\n    };\n};\n\n/**\n * A map of translation IDs to a map of reader IDs to the URL generator for the audio file.\n */\nexport const KNOWN_AUDIO_TRANSLATIONS: Map<\n    string,\n    Map<string, AudioTranslationUrlGenerator>\n> = new Map([\n    [\n        'BSB',\n        new Map([\n            ['gilbert', openBibleUrlGenerator('BSB', 'gilbert', 'G')],\n            ['hays', openBibleUrlGenerator('BSB', 'hays', 'H')],\n            ['souer', openBibleUrlGenerator('BSB', 'souer', null)],\n        ]),\n    ],\n]);\n\n/**\n * Gets the audio URLs for the given translation, book, and chapter.\n * @param translationId The ID of the translation.\n * @param bookId The ID of the book.\n * @param chapter The number of the chapter.\n */\nexport function getAudioUrlsForChapter(\n    translationId: string,\n    bookId: string,\n    chapter: number\n): TranslationBookChapterAudioLinks {\n    const translation = KNOWN_AUDIO_TRANSLATIONS.get(translationId);\n    if (!translation) {\n        return {};\n    }\n\n    const links: TranslationBookChapterAudioLinks = {};\n    for (let [reader, generator] of translation) {\n        const url = generator(bookId, chapter);\n        if (url) {\n            links[reader] = url;\n        }\n    }\n    return links;\n}\n\n/**\n * Capitalizes the first letter of the given string.\n * @param str The string to capitalize.\n */\nexport function capitalize(str: string): string {\n    const char = str.charAt(0);\n    if (/[0-9]/.test(char)) {\n        return (\n            str.charAt(0) +\n            str.charAt(1).toUpperCase() +\n            str.slice(2).toLowerCase()\n        );\n    }\n\n    return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAyB;AACzB,wBAA6B;AAK7B,MAAM,wBAI8B,CAAC,aAAa,QAAQ,YAAY;AAClE,SAAO,CAAC,QAAQ,YAAY;AACxB,UAAM,gBAAY;AAAA,MACd,+BAAa,IAAI,MAAM,EAAG,SAAS;AAAA,MACnC;AAAA,MACA;AAAA,IACJ;AACA,UAAM,iBAAa,wBAAS,QAAQ,SAAS,GAAG,GAAG,GAAG;AAEtD,QAAI,OAAO,+BAA+B,MAAM,IAAI,WAAW,IAAI,SAAS,IAAI;AAAA,MAC5E;AAAA,IACJ,CAAC,IAAI,UAAU;AAEf,QAAI,SAAS;AACT,cAAQ,IAAI,OAAO;AAAA,IACvB;AAEA,YAAQ;AAER,WAAO;AAAA,EACX;AACJ;AAKO,MAAM,2BAGT,oBAAI,IAAI;AAAA,EACR;AAAA,IACI;AAAA,IACA,oBAAI,IAAI;AAAA,MACJ,CAAC,WAAW,sBAAsB,OAAO,WAAW,GAAG,CAAC;AAAA,MACxD,CAAC,QAAQ,sBAAsB,OAAO,QAAQ,GAAG,CAAC;AAAA,MAClD,CAAC,SAAS,sBAAsB,OAAO,SAAS,IAAI,CAAC;AAAA,IACzD,CAAC;AAAA,EACL;AACJ,CAAC;AAQM,SAAS,uBACZ,eACA,QACA,SACgC;AAChC,QAAM,cAAc,yBAAyB,IAAI,aAAa;AAC9D,MAAI,CAAC,aAAa;AACd,WAAO,CAAC;AAAA,EACZ;AAEA,QAAM,QAA0C,CAAC;AACjD,WAAS,CAAC,QAAQ,SAAS,KAAK,aAAa;AACzC,UAAM,MAAM,UAAU,QAAQ,OAAO;AACrC,QAAI,KAAK;AACL,YAAM,MAAM,IAAI;AAAA,IACpB;AAAA,EACJ;AACA,SAAO;AACX;AAMO,SAAS,WAAW,KAAqB;AAC5C,QAAM,OAAO,IAAI,OAAO,CAAC;AACzB,MAAI,QAAQ,KAAK,IAAI,GAAG;AACpB,WACI,IAAI,OAAO,CAAC,IACZ,IAAI,OAAO,CAAC,EAAE,YAAY,IAC1B,IAAI,MAAM,CAAC,EAAE,YAAY;AAAA,EAEjC;AAEA,SAAO,IAAI,OAAO,CAAC,EAAE,YAAY,IAAI,IAAI,MAAM,CAAC,EAAE,YAAY;AAClE;",
+  "names": []
+}