@helloao/tools 0.0.4 → 0.0.6-alpha

package/dist/esm/utils.js

@@ -0,0 +1,51 @@
+"use strict";
+export function normalizeLanguage(language) {
+  return language;
+}
+const TRANSLATION_ID_MAP = /* @__PURE__ */ new Map([
+  ["eng_bsb", "BSB"],
+  ["arb_nav", "ARBNAV"],
+  ["eng_webp", "ENGWEBP"],
+  ["hin_irv", "HINIRV"],
+  ["hbo_mas", "HBOMAS"]
+]);
+export function getTranslationId(translationId) {
+  return TRANSLATION_ID_MAP.get(translationId) ?? translationId;
+}
+export function isEmptyOrWhitespace(str) {
+  return !str || /^\s*$/.test(str);
+}
+export function getFirstNonEmpty(...values) {
+  for (let value of values) {
+    if (!isEmptyOrWhitespace(value)) {
+      return value;
+    }
+  }
+  throw new Error("All values are empty or whitespace!");
+}
+export function parseVerseReference(text) {
+  const match = text.match(/^\s*([A-Z]+)\s+(\d+):(\d+)/);
+  if (!match) {
+    return null;
+  }
+  const [reference, book, chapterStr, verseStr] = match;
+  const chapter = parseInt(chapterStr);
+  const verse = parseInt(verseStr);
+  if (isNaN(chapter) || isNaN(verse)) {
+    return null;
+  }
+  if (reference.length !== text.length) {
+    return {
+      book,
+      chapter,
+      verse,
+      content: text.substring(reference.length).trim()
+    };
+  }
+  return {
+    book,
+    chapter,
+    verse
+  };
+}
+//# sourceMappingURL=utils.js.map

package/dist/esm/utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../utils.ts"],
+  "sourcesContent": ["\r\n/**\r\n * Normalizes the given language code into a ISO 639 code.\r\n * @param language The language code to normalize.\r\n */\r\nexport function normalizeLanguage(language: string): string {\r\n    return language;\r\n}\r\n\r\n/**\r\n * The map of translation IDs from fetch.bible to their translation ID in the API.\r\n */\r\nconst TRANSLATION_ID_MAP: Map<string, string> = new Map([\r\n    ['eng_bsb', 'BSB'],\r\n    ['arb_nav', 'ARBNAV'],\r\n    ['eng_webp', 'ENGWEBP'],\r\n    ['hin_irv', 'HINIRV'],\r\n    ['hbo_mas', 'HBOMAS'],\r\n]);\r\n\r\n/**\r\n * Gets the ID of the translation.\r\n * @param translation The translation to get the ID for.\r\n */\r\nexport function getTranslationId(translationId: string): string {\r\n    return TRANSLATION_ID_MAP.get(translationId) ?? translationId;\r\n}\r\n\r\nexport function isEmptyOrWhitespace(str: string | null | undefined): boolean {\r\n    return !str || /^\\s*$/.test(str);\r\n}\r\n\r\nexport function getFirstNonEmpty<T extends string>(...values: T[]): T {\r\n    for (let value of values) {\r\n        if (!isEmptyOrWhitespace(value)) {\r\n            return value;\r\n        }\r\n    }\r\n\r\n    throw new Error('All values are empty or whitespace!');\r\n}\r\n\r\nexport interface VerseRef {\r\n    book: string;\r\n    chapter: number;\r\n    verse: number;\r\n\r\n    /**\r\n     * The rest of the content of the verse.\r\n     */\r\n    content?: string;\r\n}\r\n\r\n/**\r\n * Parses the given verse reference.\r\n * Formatted like \"GEN 1:1\".\r\n * \r\n * @param text The reference to parse.\r\n */\r\nexport function parseVerseReference(text: string): VerseRef | null {\r\n    const match = text.match(/^\\s*([A-Z]+)\\s+(\\d+):(\\d+)/);\r\n\r\n    if (!match) {\r\n        return null;\r\n    }\r\n\r\n    const [reference, book, chapterStr, verseStr] = match;\r\n\r\n    const chapter = parseInt(chapterStr);\r\n    const verse = parseInt(verseStr);\r\n\r\n    if (isNaN(chapter) || isNaN(verse)) {\r\n        return null;\r\n    }\r\n\r\n    if (reference.length !== text.length) {\r\n        return {\r\n            book,\r\n            chapter,\r\n            verse,\r\n            content: text.substring(reference.length).trim(),\r\n        };\r\n    }\r\n\r\n    return {\r\n        book,\r\n        chapter,\r\n        verse,\r\n    };\r\n}"],
+  "mappings": ";AAKO,gBAAS,kBAAkB,UAA0B;AACxD,SAAO;AACX;AAKA,MAAM,qBAA0C,oBAAI,IAAI;AAAA,EACpD,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,WAAW,QAAQ;AAAA,EACpB,CAAC,YAAY,SAAS;AAAA,EACtB,CAAC,WAAW,QAAQ;AAAA,EACpB,CAAC,WAAW,QAAQ;AACxB,CAAC;AAMM,gBAAS,iBAAiB,eAA+B;AAC5D,SAAO,mBAAmB,IAAI,aAAa,KAAK;AACpD;AAEO,gBAAS,oBAAoB,KAAyC;AACzE,SAAO,CAAC,OAAO,QAAQ,KAAK,GAAG;AACnC;AAEO,gBAAS,oBAAsC,QAAgB;AAClE,WAAS,SAAS,QAAQ;AACtB,QAAI,CAAC,oBAAoB,KAAK,GAAG;AAC7B,aAAO;AAAA,IACX;AAAA,EACJ;AAEA,QAAM,IAAI,MAAM,qCAAqC;AACzD;AAmBO,gBAAS,oBAAoB,MAA+B;AAC/D,QAAM,QAAQ,KAAK,MAAM,4BAA4B;AAErD,MAAI,CAAC,OAAO;AACR,WAAO;AAAA,EACX;AAEA,QAAM,CAAC,WAAW,MAAM,YAAY,QAAQ,IAAI;AAEhD,QAAM,UAAU,SAAS,UAAU;AACnC,QAAM,QAAQ,SAAS,QAAQ;AAE/B,MAAI,MAAM,OAAO,KAAK,MAAM,KAAK,GAAG;AAChC,WAAO;AAAA,EACX;AAEA,MAAI,UAAU,WAAW,KAAK,QAAQ;AAClC,WAAO;AAAA,MACH;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,KAAK,UAAU,UAAU,MAAM,EAAE,KAAK;AAAA,IACnD;AAAA,EACJ;AAEA,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AACJ;",
+  "names": []
+}

package/{generation → dist/types/generation}/api.d.ts

@@ -1,5 +1,5 @@
-import { OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from "./common-types";
-import { DatasetOutput } from "./dataset";
+import { OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from './common-types.js';
+import { DatasetOutput } from './dataset.js';
 /**
  * Defines the output of the API generation.
  */
@@ -27,6 +27,10 @@ export interface ApiOutput {
      * - /api/:translationId/:bookId/:chapterNumber.:reader.mp3
      */
     translationBookChapterAudio: ApiTranslationBookChapterAudio[];
+    /**
+     * The path prefix that the API should use.
+     */
+    pathPrefix: string;
 }
 /**
  * The list of available translations.
@@ -168,6 +172,9 @@ export interface ApiTranslationBookChapterAudio {
      */
     originalUrl: string;
 }
+/**
+ * The options for generating the API.
+ */
 export interface GenerateApiOptions {
     /**
      * Whether to use the common name for the book chapter API link. If false, then book IDs are used.
@@ -182,6 +189,22 @@ export interface GenerateApiOptions {
      * Defaults to false.
      */
     generateAudioFiles?: boolean;
+    /**
+     * Gets the english name of the given language.
+     * If not provided, then the english name for the language will be unknown and omitted.
+     * @param language The language to get the english name for.
+     */
+    getEnglishName?: (language: string) => string | null | undefined;
+    /**
+     * Gets the native name of the given language.
+     * If not provided, then the native name for the language will be unknown and omitted.
+     * @param language The language to get the native name for.
+     */
+    getNativeName?: (language: string) => string | null | undefined;
+    /**
+     * The prefix that should be added to paths that are generated.
+     */
+    pathPrefix?: string;
 }
 /**
  * Generates the API output for the given dataset.
@@ -194,9 +217,27 @@ export declare function generateApiForDataset(dataset: DatasetOutput, options?:
  * @param api The API that the files should be generated for.
  */
 export declare function generateFilesForApi(api: ApiOutput): OutputFile[];
-export declare function listOfBooksApiLink(translationId: string): string;
-export declare function bookChapterApiLink(translationId: string, commonName: string, chapterNumber: number, extension: string): string;
-export declare function bookChapterAudioApiLink(translationId: string, bookId: string, chapterNumber: number, reader: string): string;
+/**
+ * Generates the output files for the given datasets.
+ * @param datasets The datasets to generate the output files for.
+ * @param options The options for generating the API files.
+ */
+export declare function generateOutputFilesFromDatasets(datasets: AsyncIterable<DatasetOutput>, options?: GenerateApiOptions): AsyncGenerator<OutputFile[]>;
+/**
+ * Gets the API Link for the list of books endpoint for a translation.
+ * @param translationId The ID of the translation.
+ * @returns
+ */
+export declare function listOfBooksApiLink(translationId: string, prefix?: string): string;
+/**
+ * Getes the API link for a book chapter.
+ * @param translationId The ID of the translation.
+ * @param commonName The name of the book.
+ * @param chapterNumber The number of the book.
+ * @param extension The extension of the file.
+ */
+export declare function bookChapterApiLink(translationId: string, commonName: string, chapterNumber: number, extension: string, prefix?: string): string;
+export declare function bookChapterAudioApiLink(translationId: string, bookId: string, chapterNumber: number, reader: string, prefix?: string): string;
 export declare function jsonFile(path: string, content: any, mergable?: boolean): OutputFile;
 export declare function downloadedFile(path: string, url: string): OutputFile;
 export declare function replaceSpacesWithUnderscores(str: string): string;

package/{generation → dist/types/generation}/audio.d.ts

@@ -1,4 +1,4 @@
-import { TranslationBookChapterAudioLinks } from "./common-types";
+import { TranslationBookChapterAudioLinks } from './common-types.js';
 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.

package/{generation → dist/types/generation}/dataset.d.ts

@@ -1,4 +1,4 @@
-import { InputFile, Translation, TranslationBook, TranslationBookChapter } from "./common-types";
+import { InputFile, Translation, TranslationBook, TranslationBookChapter } from './common-types.js';
 /**
  * Defines an interface that contains generated dataset info.
  */

package/dist/types/generation/index.d.ts

@@ -0,0 +1,7 @@
+import * as api from './api.js';
+import * as audio from './audio.js';
+import * as dataset from './dataset.js';
+import * as bookOrder from './book-order.js';
+export * from './common-types.js';
+export { api, audio, dataset, bookOrder };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+import * as utils from './utils.js';
+import * as generation from './generation/index.js';
+import * as parser from './parser/index.js';
+export { utils, generation, parser };
+//# sourceMappingURL=index.d.ts.map

package/{parser → dist/types/parser}/codex-parser.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { ParseTree } from './types';
+import { ParseTree } from './types.js';
 export declare const chapterHeadingSchema: z.ZodObject<{
     type: z.ZodLiteral<"chapter-heading">;
     data: z.ZodObject<{

package/dist/types/parser/index.d.ts

@@ -0,0 +1,7 @@
+export * from './types.js';
+export * from './usfm-parser.js';
+export * from './usx-parser.js';
+export * from './codex-parser.js';
+import * as iterators from './iterators.js';
+export { iterators };
+//# sourceMappingURL=index.d.ts.map

package/{parser → dist/types/parser}/usfm-parser.d.ts

@@ -1,4 +1,4 @@
-import { ParseTree } from './types';
+import { ParseTree } from './types.js';
 /**
  * Defines a class that can tokenize a stream of characters into tokens.
  */

package/{parser → dist/types/parser}/usx-parser.d.ts

@@ -1,5 +1,5 @@
-import { Chapter, ChapterContent, FootnoteReference, ParseTree, Verse, Text, HebrewSubtitle, InlineLineBreak } from "./types";
-import { RewindableIterator } from "./iterators";
+import { Chapter, ChapterContent, FootnoteReference, ParseTree, Verse, Text, HebrewSubtitle, InlineLineBreak } from './types.js';
+import { RewindableIterator } from './iterators.js';
 /**
  * The version of the parser.
  * Used to determine whether input files need to be re-parsed.

package/package.json

@@ -1,14 +1,33 @@
 {
   "name": "@helloao/tools",
-  "version": "0.0.4",
+  "version": "0.0.6-alpha",
   "description": "A set of tools for managing HelloAO's Free Bible API",
-  "module": "index.js",
-  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.cjs"
+    },
+    "./*.js": {
+      "types": "./dist/types/*.d.ts",
+      "import": "./dist/esm/*.js",
+      "require": "./dist/cjs/*.cjs"
+    },
+    "./parser/*.js": {
+      "types": "./dist/types/parser/*.d.ts",
+      "import": "./dist/esm/parser/*.js",
+      "require": "./dist/cjs/parser/*.cjs"
+    },
+    "./generation/*.js": {
+      "types": "./dist/types/generation/*.d.ts",
+      "import": "./dist/esm/generation/*.js",
+      "require": "./dist/cjs/generation/*.cjs"
+    }
+  },
   "author": "Kallyn Gowdy <kal@helloao.org>",
   "license": "MIT",
   "dependencies": {
     "lodash": "4.17.21",
-    "all-iso-language-codes": "1.0.17",
     "zod": "^3.23.8"
   },
   "devDependencies": {
@@ -21,6 +40,8 @@
     "/migrations/**/*.sql",
     "**/*.js",
     "**/*.js.map",
+    "**/*.cjs",
+    "**/*.cjs.map",
     "**/*.d.ts"
   ],
   "scripts": {}

package/generation/api.js

@@ -1,153 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateApiForDataset = generateApiForDataset;
-exports.generateFilesForApi = generateFilesForApi;
-exports.listOfBooksApiLink = listOfBooksApiLink;
-exports.bookChapterApiLink = bookChapterApiLink;
-exports.bookChapterAudioApiLink = bookChapterAudioApiLink;
-exports.jsonFile = jsonFile;
-exports.downloadedFile = downloadedFile;
-exports.replaceSpacesWithUnderscores = replaceSpacesWithUnderscores;
-const all_iso_language_codes_1 = require("all-iso-language-codes");
-/**
- * Generates the API output for the given dataset.
- * @param dataset The dataset to generate the API for.
- * @param options The options for generating the API.
- */
-function generateApiForDataset(dataset, options = {}) {
-    const { useCommonName } = options;
-    let api = {
-        availableTranslations: {
-            translations: [],
-        },
-        translationBooks: [],
-        translationBookChapters: [],
-        translationBookChapterAudio: [],
-    };
-    for (let { books, ...translation } of dataset.translations) {
-        const apiTranslation = {
-            ...translation,
-            availableFormats: ['json'],
-            listOfBooksApiLink: listOfBooksApiLink(translation.id),
-            numberOfBooks: books.length,
-            totalNumberOfChapters: 0,
-            totalNumberOfVerses: 0,
-            languageName: (0, all_iso_language_codes_1.getNativeName)(translation.language) ?? undefined,
-            languageEnglishName: (0, all_iso_language_codes_1.getEnglishName)(translation.language) ?? undefined,
-        };
-        const translationBooks = {
-            translation: apiTranslation,
-            books: [],
-        };
-        let translationChapters = [];
-        for (let { chapters, ...book } of books) {
-            const apiBook = {
-                ...book,
-                firstChapterApiLink: bookChapterApiLink(translation.id, getBookLink(book), 1, 'json'),
-                lastChapterApiLink: bookChapterApiLink(translation.id, getBookLink(book), chapters.length, 'json'),
-                numberOfChapters: chapters.length,
-                totalNumberOfVerses: 0,
-            };
-            for (let { chapter, thisChapterAudioLinks } of chapters) {
-                const audio = {};
-                const apiBookChapter = {
-                    translation: apiTranslation,
-                    book: apiBook,
-                    chapter: chapter,
-                    thisChapterLink: bookChapterApiLink(translation.id, getBookLink(book), chapter.number, 'json'),
-                    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),
-                            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');
-                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');
-                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;
-    }
-}
-/**
- * Generates the output files for the given API.
- * @param api The API that the files should be generated for.
- */
-function generateFilesForApi(api) {
-    let files = [];
-    files.push(jsonFile('/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;
-}
-;
-function listOfBooksApiLink(translationId) {
-    return `/api/${translationId}/books.json`;
-}
-function bookChapterApiLink(translationId, commonName, chapterNumber, extension) {
-    return `/api/${translationId}/${replaceSpacesWithUnderscores(commonName)}/${chapterNumber}.${extension}`;
-}
-function bookChapterAudioApiLink(translationId, bookId, chapterNumber, reader) {
-    return `/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, '_');
-}

package/generation/api.spec.d.ts

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