@helloao/tools 0.0.6 → 0.0.10

package/dist/esm/utils.js

@@ -0,0 +1,201 @@
+"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*([0-9A-Za-z\s]+)\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: getBookId(book) ?? book,
+      chapter,
+      verse,
+      content: text.substring(reference.length).trim()
+    };
+  }
+  return {
+    book: getBookId(book) ?? book,
+    chapter,
+    verse
+  };
+}
+const BOOK_ID_MAP = /* @__PURE__ */ new Map([
+  ["gen", "GEN"],
+  ["genesis", "GEN"],
+  ["exo", "EXO"],
+  ["exodus", "EXO"],
+  ["lev", "LEV"],
+  ["lev", "LEV"],
+  ["laviticus", "LEV"],
+  ["num", "NUM"],
+  ["numbers", "NUM"],
+  ["deu", "DEU"],
+  ["deuteronomy", "DEU"],
+  ["jos", "JOS"],
+  ["joshua", "JOS"],
+  ["jdg", "JDG"],
+  ["judges", "JDG"],
+  ["rut", "RUT"],
+  ["ruth", "RUT"],
+  ["1sa", "1SA"],
+  ["1samuel", "1SA"],
+  ["2sa", "2SA"],
+  ["2samuel", "2SA"],
+  ["1ki", "1KI"],
+  ["1kings", "1KI"],
+  ["2ki", "2KI"],
+  ["2kings", "2KI"],
+  ["1ch", "1CH"],
+  ["1chronicles", "1CH"],
+  ["chronicles1", "1CH"],
+  ["2ch", "2CH"],
+  ["2chronicles", "2CH"],
+  ["chronicles2", "2CH"],
+  ["ezr", "EZR"],
+  ["ezra", "EZR"],
+  ["neh", "NEH"],
+  ["nehemiah", "NEH"],
+  ["est", "EST"],
+  ["ester", "EST"],
+  ["job", "JOB"],
+  ["psa", "PSA"],
+  ["psalms", "PSA"],
+  ["psalm", "PSA"],
+  ["pro", "PRO"],
+  ["proverbs", "PRO"],
+  ["ecc", "ECC"],
+  ["ecclesiastes", "ECC"],
+  ["sng", "SNG"],
+  ["songofsolomon", "SNG"],
+  ["isa", "ISA"],
+  ["isaiah", "ISA"],
+  ["jer", "JER"],
+  ["jeremiah", "JER"],
+  ["lam", "LAM"],
+  ["lamentations", "LAM"],
+  ["ezk", "EZK"],
+  ["ezekiel", "EZK"],
+  ["dan", "DAN"],
+  ["daniel", "DAN"],
+  ["hos", "HOS"],
+  ["hosea", "HOS"],
+  ["jol", "JOL"],
+  ["joel", "JOL"],
+  ["amo", "AMO"],
+  ["amos", "AMO"],
+  ["oba", "OBA"],
+  ["obadiah", "OBA"],
+  ["jon", "JON"],
+  ["jonah", "JON"],
+  ["mic", "MIC"],
+  ["micah", "MIC"],
+  ["nam", "NAM"],
+  ["nahum", "NAM"],
+  ["hab", "HAB"],
+  ["habakkuk", "HAB"],
+  ["zep", "ZEP"],
+  ["zepaniah", "ZEP"],
+  ["hag", "HAG"],
+  ["haggai", "HAG"],
+  ["zec", "ZEC"],
+  ["zechariah", "ZEC"],
+  ["mal", "MAL"],
+  ["malachi", "MAL"],
+  ["mat", "MAT"],
+  ["matthew", "MAT"],
+  ["mrk", "MRK"],
+  ["mark", "MRK"],
+  ["luk", "LUK"],
+  ["luke", "LUK"],
+  ["jhn", "JHN"],
+  ["john", "JHN"],
+  ["act", "ACT"],
+  ["acts", "ACT"],
+  ["rom", "ROM"],
+  ["romans", "ROM"],
+  ["1co", "1CO"],
+  ["1corinthians", "1CO"],
+  ["2co", "2CO"],
+  ["2corinthians", "2CO"],
+  ["gal", "GAL"],
+  ["galatians", "GAL"],
+  ["eph", "EPH"],
+  ["ephesians", "EPH"],
+  ["php", "PHP"],
+  ["philippians", "PHP"],
+  ["col", "COL"],
+  ["colossians", "COL"],
+  ["1th", "1TH"],
+  ["1thessalonians", "1TH"],
+  ["2th", "2TH"],
+  ["2thessalonians", "2TH"],
+  ["1ti", "1TI"],
+  ["1timothy", "1TI"],
+  ["2ti", "2TI"],
+  ["2timothy", "2TI"],
+  ["tit", "TIT"],
+  ["titus", "TIT"],
+  ["phm", "PHM"],
+  ["philemon", "PHM"],
+  ["heb", "HEB"],
+  ["hebrews", "HEB"],
+  ["jas", "JAS"],
+  ["james", "JAS"],
+  ["1pe", "1PE"],
+  ["1peter", "1PE"],
+  ["2pe", "2PE"],
+  ["2peter", "2PE"],
+  ["1jn", "1JN"],
+  ["1john", "1JN"],
+  ["2jn", "2JN"],
+  ["2john", "2JN"],
+  ["3jn", "3JN"],
+  ["3john", "3JN"],
+  ["jud", "JUD"],
+  ["jude", "JUD"],
+  ["rev", "REV"],
+  ["revelation", "REV"]
+]);
+export function getBookId(book) {
+  const bookLower = book.toLowerCase().replaceAll(/\s+/g, "");
+  const id = BOOK_ID_MAP.get(bookLower);
+  if (id) {
+    return id;
+  }
+  for (let [key, id2] of BOOK_ID_MAP) {
+    if (bookLower.startsWith(key)) {
+      return id2;
+    }
+  }
+  return null;
+}
+//# sourceMappingURL=utils.js.map

package/dist/esm/utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../utils.ts"],
+  "sourcesContent": ["/**\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*([0-9A-Za-z\\s]+)\\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: getBookId(book) ?? 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: getBookId(book) ?? book,\r\n        chapter,\r\n        verse,\r\n    };\r\n}\r\n\r\n/**\r\n * Defines a map that maps the book ID to the numerical order of the book.\r\n */\r\nconst BOOK_ID_MAP: Map<string, string> = new Map([\r\n    ['gen', 'GEN'],\r\n    ['genesis', 'GEN'],\r\n    ['exo', 'EXO'],\r\n    ['exodus', 'EXO'],\r\n    ['lev', 'LEV'],\r\n    ['lev', 'LEV'],\r\n    ['laviticus', 'LEV'],\r\n    ['num', 'NUM'],\r\n    ['numbers', 'NUM'],\r\n    ['deu', 'DEU'],\r\n    ['deuteronomy', 'DEU'],\r\n    ['jos', 'JOS'],\r\n    ['joshua', 'JOS'],\r\n    ['jdg', 'JDG'],\r\n    ['judges', 'JDG'],\r\n    ['rut', 'RUT'],\r\n    ['ruth', 'RUT'],\r\n    ['1sa', '1SA'],\r\n    ['1samuel', '1SA'],\r\n    ['2sa', '2SA'],\r\n    ['2samuel', '2SA'],\r\n    ['1ki', '1KI'],\r\n    ['1kings', '1KI'],\r\n    ['2ki', '2KI'],\r\n    ['2kings', '2KI'],\r\n    ['1ch', '1CH'],\r\n    ['1chronicles', '1CH'],\r\n    ['chronicles1', '1CH'],\r\n    ['2ch', '2CH'],\r\n    ['2chronicles', '2CH'],\r\n    ['chronicles2', '2CH'],\r\n    ['ezr', 'EZR'],\r\n    ['ezra', 'EZR'],\r\n    ['neh', 'NEH'],\r\n    ['nehemiah', 'NEH'],\r\n    ['est', 'EST'],\r\n    ['ester', 'EST'],\r\n    ['job', 'JOB'],\r\n    ['psa', 'PSA'],\r\n    ['psalms', 'PSA'],\r\n    ['psalm', 'PSA'],\r\n    ['pro', 'PRO'],\r\n    ['proverbs', 'PRO'],\r\n    ['ecc', 'ECC'],\r\n    ['ecclesiastes', 'ECC'],\r\n    ['sng', 'SNG'],\r\n    ['songofsolomon', 'SNG'],\r\n    ['isa', 'ISA'],\r\n    ['isaiah', 'ISA'],\r\n    ['jer', 'JER'],\r\n    ['jeremiah', 'JER'],\r\n    ['lam', 'LAM'],\r\n    ['lamentations', 'LAM'],\r\n    ['ezk', 'EZK'],\r\n    ['ezekiel', 'EZK'],\r\n    ['dan', 'DAN'],\r\n    ['daniel', 'DAN'],\r\n    ['hos', 'HOS'],\r\n    ['hosea', 'HOS'],\r\n    ['jol', 'JOL'],\r\n    ['joel', 'JOL'],\r\n    ['amo', 'AMO'],\r\n    ['amos', 'AMO'],\r\n    ['oba', 'OBA'],\r\n    ['obadiah', 'OBA'],\r\n    ['jon', 'JON'],\r\n    ['jonah', 'JON'],\r\n    ['mic', 'MIC'],\r\n    ['micah', 'MIC'],\r\n    ['nam', 'NAM'],\r\n    ['nahum', 'NAM'],\r\n    ['hab', 'HAB'],\r\n    ['habakkuk', 'HAB'],\r\n    ['zep', 'ZEP'],\r\n    ['zepaniah', 'ZEP'],\r\n    ['hag', 'HAG'],\r\n    ['haggai', 'HAG'],\r\n    ['zec', 'ZEC'],\r\n    ['zechariah', 'ZEC'],\r\n    ['mal', 'MAL'],\r\n    ['malachi', 'MAL'],\r\n    ['mat', 'MAT'],\r\n    ['matthew', 'MAT'],\r\n    ['mrk', 'MRK'],\r\n    ['mark', 'MRK'],\r\n    ['luk', 'LUK'],\r\n    ['luke', 'LUK'],\r\n    ['jhn', 'JHN'],\r\n    ['john', 'JHN'],\r\n    ['act', 'ACT'],\r\n    ['acts', 'ACT'],\r\n    ['rom', 'ROM'],\r\n    ['romans', 'ROM'],\r\n    ['1co', '1CO'],\r\n    ['1corinthians', '1CO'],\r\n    ['2co', '2CO'],\r\n    ['2corinthians', '2CO'],\r\n    ['gal', 'GAL'],\r\n    ['galatians', 'GAL'],\r\n    ['eph', 'EPH'],\r\n    ['ephesians', 'EPH'],\r\n    ['php', 'PHP'],\r\n    ['philippians', 'PHP'],\r\n    ['col', 'COL'],\r\n    ['colossians', 'COL'],\r\n    ['1th', '1TH'],\r\n    ['1thessalonians', '1TH'],\r\n    ['2th', '2TH'],\r\n    ['2thessalonians', '2TH'],\r\n    ['1ti', '1TI'],\r\n    ['1timothy', '1TI'],\r\n    ['2ti', '2TI'],\r\n    ['2timothy', '2TI'],\r\n    ['tit', 'TIT'],\r\n    ['titus', 'TIT'],\r\n    ['phm', 'PHM'],\r\n    ['philemon', 'PHM'],\r\n    ['heb', 'HEB'],\r\n    ['hebrews', 'HEB'],\r\n    ['jas', 'JAS'],\r\n    ['james', 'JAS'],\r\n    ['1pe', '1PE'],\r\n    ['1peter', '1PE'],\r\n    ['2pe', '2PE'],\r\n    ['2peter', '2PE'],\r\n    ['1jn', '1JN'],\r\n    ['1john', '1JN'],\r\n    ['2jn', '2JN'],\r\n    ['2john', '2JN'],\r\n    ['3jn', '3JN'],\r\n    ['3john', '3JN'],\r\n    ['jud', 'JUD'],\r\n    ['jude', 'JUD'],\r\n    ['rev', 'REV'],\r\n    ['revelation', 'REV'],\r\n]);\r\n\r\n/**\r\n * Gets the ID of the given book.\r\n * Returns null if the ID could not be found.\r\n * @param book The name/ID of the book.\r\n */\r\nexport function getBookId(book: string): string | null {\r\n    const bookLower = book.toLowerCase().replaceAll(/\\s+/g, '');\r\n\r\n    const id = BOOK_ID_MAP.get(bookLower);\r\n    if (id) {\r\n        return id;\r\n    }\r\n\r\n    for (let [key, id] of BOOK_ID_MAP) {\r\n        if (bookLower.startsWith(key)) {\r\n            return id;\r\n        }\r\n    }\r\n\r\n    return null;\r\n}\r\n"],
+  "mappings": ";AAIO,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,oCAAoC;AAE7D,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,MAAM,UAAU,IAAI,KAAK;AAAA,MACzB;AAAA,MACA;AAAA,MACA,SAAS,KAAK,UAAU,UAAU,MAAM,EAAE,KAAK;AAAA,IACnD;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,MAAM,UAAU,IAAI,KAAK;AAAA,IACzB;AAAA,IACA;AAAA,EACJ;AACJ;AAKA,MAAM,cAAmC,oBAAI,IAAI;AAAA,EAC7C,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,aAAa,KAAK;AAAA,EACnB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,eAAe,KAAK;AAAA,EACrB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,eAAe,KAAK;AAAA,EACrB,CAAC,eAAe,KAAK;AAAA,EACrB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,eAAe,KAAK;AAAA,EACrB,CAAC,eAAe,KAAK;AAAA,EACrB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,YAAY,KAAK;AAAA,EAClB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,YAAY,KAAK;AAAA,EAClB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,gBAAgB,KAAK;AAAA,EACtB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,iBAAiB,KAAK;AAAA,EACvB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,YAAY,KAAK;AAAA,EAClB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,gBAAgB,KAAK;AAAA,EACtB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,YAAY,KAAK;AAAA,EAClB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,YAAY,KAAK;AAAA,EAClB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,aAAa,KAAK;AAAA,EACnB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,gBAAgB,KAAK;AAAA,EACtB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,gBAAgB,KAAK;AAAA,EACtB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,aAAa,KAAK;AAAA,EACnB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,aAAa,KAAK;AAAA,EACnB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,eAAe,KAAK;AAAA,EACrB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,cAAc,KAAK;AAAA,EACpB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,kBAAkB,KAAK;AAAA,EACxB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,kBAAkB,KAAK;AAAA,EACxB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,YAAY,KAAK;AAAA,EAClB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,YAAY,KAAK;AAAA,EAClB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,YAAY,KAAK;AAAA,EAClB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,WAAW,KAAK;AAAA,EACjB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,UAAU,KAAK;AAAA,EAChB,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,SAAS,KAAK;AAAA,EACf,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,QAAQ,KAAK;AAAA,EACd,CAAC,OAAO,KAAK;AAAA,EACb,CAAC,cAAc,KAAK;AACxB,CAAC;AAOM,gBAAS,UAAU,MAA6B;AACnD,QAAM,YAAY,KAAK,YAAY,EAAE,WAAW,QAAQ,EAAE;AAE1D,QAAM,KAAK,YAAY,IAAI,SAAS;AACpC,MAAI,IAAI;AACJ,WAAO;AAAA,EACX;AAEA,WAAS,CAAC,KAAKA,GAAE,KAAK,aAAa;AAC/B,QAAI,UAAU,WAAW,GAAG,GAAG;AAC3B,aAAOA;AAAA,IACX;AAAA,EACJ;AAEA,SAAO;AACX;",
+  "names": ["id"]
+}

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 { Commentary, CommentaryBook, CommentaryBookChapter, OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from './common-types.js';
+import { DatasetOutput } from './dataset.js';
 /**
  * Defines the output of the API generation.
  */
@@ -27,6 +27,22 @@ export interface ApiOutput {
      * - /api/:translationId/:bookId/:chapterNumber.:reader.mp3
      */
     translationBookChapterAudio: ApiTranslationBookChapterAudio[];
+    /**
+     * The list of available commentaries.
+     * This maps to the /api/available-commentaries.json endpoint.
+     */
+    availableCommentaries: ApiAvailableCommentaries;
+    /**
+     * The list of books for each commentary.
+     * This maps to the /api/c/:commentaryId/books.json endpoint.
+     */
+    commentaryBooks: ApiCommentaryBooks[];
+    /**
+     * The list of chapters for each commentary book.
+     * This maps to the following endpoint:
+     * - /api/c/:commentaryId/:bookId/:chapterNumber.json
+     */
+    commentaryBookChapters: ApiCommentaryBookChapter[];
     /**
      * The path prefix that the API should use.
      */
@@ -42,6 +58,16 @@ export interface ApiAvailableTranslations {
      */
     translations: ApiTranslation[];
 }
+/**
+ * The list of available commentaries.
+ * Maps to the /api/available-commentaries.json endpoint.
+ */
+export interface ApiAvailableCommentaries {
+    /**
+     * The list of commentaries.
+     */
+    commentaries: ApiCommentary[];
+}
 /**
  * Defines a translation that is used in the API.
  */
@@ -83,6 +109,47 @@ export interface ApiTranslation extends Translation {
      */
     languageEnglishName?: string;
 }
+/**
+ * Defines a commentary that is used in the API.
+ */
+export interface ApiCommentary extends Commentary {
+    /**
+     * The API link for the list of available books for this translation.
+     */
+    listOfBooksApiLink: string;
+    /**
+     * The available list of formats.
+     */
+    availableFormats: ('json' | 'usfm')[];
+    /**
+     * The number of books that are contained in this commentary.
+     *
+     * Complete commentaries should have the same number of books as the Bible (66).
+     */
+    numberOfBooks: number;
+    /**
+     * The total number of chapters that are contained in this translation.
+     *
+     * Complete commentaries should have the same number of chapters as the Bible (1,189).
+     */
+    totalNumberOfChapters: number;
+    /**
+     * The total number of verses that are contained in this commentary.
+     *
+     * Complete commentaries should have the same number of verses as the Bible (around 31,102 - some commentaries exclude verses based on the aparent likelyhood of existing in the original source texts).
+     */
+    totalNumberOfVerses: number;
+    /**
+     * Gets the name of the language that the commentary is in.
+     * Null or undefined if the name of the language is not known.
+     */
+    languageName?: string;
+    /**
+     * Gets the name of the language in English.
+     * Null or undefined if the language doesn't have an english name.
+     */
+    languageEnglishName?: string;
+}
 /**
  * Defines an interface that contains information about the books that are available for a translation.
  */
@@ -96,6 +163,19 @@ export interface ApiTranslationBooks {
      */
     books: ApiTranslationBook[];
 }
+/**
+ * Defines an interface that contains information about the books that are available for a commentary.
+ */
+export interface ApiCommentaryBooks {
+    /**
+     * The commentary information for the books.
+     */
+    commentary: ApiCommentary;
+    /**
+     * The list of books that are available for the commentary.
+     */
+    books: ApiCommentaryBook[];
+}
 /**
  * Defines a translation book that is used in the API.
  */
@@ -117,6 +197,27 @@ export interface ApiTranslationBook extends TranslationBook {
      */
     totalNumberOfVerses: number;
 }
+/**
+ * Defines a commentary book that is used in the API.
+ */
+export interface ApiCommentaryBook extends CommentaryBook {
+    /**
+     * The link to the first chapter of the book.
+     */
+    firstChapterApiLink: string;
+    /**
+     * The link to the last chapter of the book.
+     */
+    lastChapterApiLink: string;
+    /**
+     * The number of chapters that the book contains.
+     */
+    numberOfChapters: number;
+    /**
+     * The number of verses that the book contains.
+     */
+    totalNumberOfVerses: number;
+}
 /**
  * Defines an interface that contains information about a book chapter.
  */
@@ -158,6 +259,37 @@ export interface ApiTranslationBookChapter extends TranslationBookChapter {
      */
     numberOfVerses: number;
 }
+/**
+ * Defines an interface that contains information about a book chapter.
+ */
+export interface ApiCommentaryBookChapter extends CommentaryBookChapter {
+    /**
+     * The commentary information for the book chapter.
+     */
+    commentary: ApiCommentary;
+    /**
+     * The book information for the book chapter.
+     */
+    book: ApiCommentaryBook;
+    /**
+     * The link to this chapter.
+     */
+    thisChapterLink: string;
+    /**
+     * The link to the next chapter.
+     * Null if this is the last chapter in the translation.
+     */
+    nextChapterApiLink: string | null;
+    /**
+     * The link to the previous chapter.
+     * Null if this is the first chapter in the translation.
+     */
+    previousChapterApiLink: string | null;
+    /**
+     * The number of verses that the chapter contains.
+     */
+    numberOfVerses: number;
+}
 export interface ApiTranslationBookChapterAudio {
     /**
      * The chapter that the audio is for.
@@ -229,6 +361,12 @@ export declare function generateOutputFilesFromDatasets(datasets: AsyncIterable<
  * @returns
  */
 export declare function listOfBooksApiLink(translationId: string, prefix?: string): string;
+/**
+ * Gets the API Link for the list of books endpoint for a commentary.
+ * @param commentaryId The ID of the commentary.
+ * @returns
+ */
+export declare function listOfCommentaryBooksApiLink(commentaryId: string, prefix?: string): string;
 /**
  * Getes the API link for a book chapter.
  * @param translationId The ID of the translation.
@@ -237,6 +375,14 @@ export declare function listOfBooksApiLink(translationId: string, prefix?: strin
  * @param extension The extension of the file.
  */
 export declare function bookChapterApiLink(translationId: string, commonName: string, chapterNumber: number, extension: 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 bookCommentaryChapterApiLink(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;

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}/common-types.d.ts

@@ -1,12 +1,20 @@
 /**
  * Defines an interface that contains information about a input file.
  */
-export interface InputFile {
+export type InputFile = InputTranslationFile | InputCommentaryFile;
+export interface InputFileBase {
     name?: string;
-    metadata: ParseTreeMetadata;
     content: string;
     sha256?: string;
+}
+export type InputFileMetadata = InputTranslationMetadata | InputCommentaryMetadata;
+export interface InputTranslationFile extends InputFileBase {
     fileType: 'usfm' | 'usx' | 'json';
+    metadata: InputTranslationMetadata;
+}
+export interface InputCommentaryFile extends InputFileBase {
+    fileType: 'commentary/csv';
+    metadata: InputCommentaryMetadata;
 }
 export type OutputFileContent = object | ReadableStream;
 /**
@@ -26,23 +34,7 @@ export interface OutputFile {
      */
     mergable?: boolean;
 }
-/**
- * Defines an interface that contains metadata for a parse tree.
- */
-export interface ParseTreeMetadata {
-    /**
-     * Information about the translation.
-     */
-    translation: InputTranslationMetadata;
-}
-/**
- * The metadata for a translation that is input into the generator.
- */
-export interface InputTranslationMetadata {
-    /**
-     * The ID of the translation.
-     */
-    id: string;
+export interface MetadataBase {
     /**
      * The name of the translation.
      */
@@ -59,10 +51,6 @@ export interface InputTranslationMetadata {
      * The URL that the license for the translation can be found.
      */
     licenseUrl: string;
-    /**
-     * The short name for the translation.
-     */
-    shortName?: string;
     /**
      * The ISO 639 letter language tag that the translation is primarily in.
      */
@@ -72,6 +60,28 @@ export interface InputTranslationMetadata {
      */
     direction: 'ltr' | 'rtl';
 }
+/**
+ * The metadata for a translation that is input into the generator.
+ */
+export interface InputTranslationMetadata extends MetadataBase {
+    /**
+     * The ID of the translation.
+     */
+    id: string;
+    /**
+     * The short name for the translation.
+     */
+    shortName?: string;
+}
+/**
+ * The metadata for a translation that is input into the generator.
+ */
+export interface InputCommentaryMetadata extends MetadataBase {
+    /**
+     * The ID of the commentary.
+     */
+    id: string;
+}
 /**
  * Defines an interface that contains information about a translation.
  */
@@ -111,12 +121,47 @@ export interface Translation {
      */
     textDirection: 'ltr' | 'rtl';
 }
+/**
+ * Defines an interface that contains information about a commentary.
+ */
+export interface Commentary {
+    /**
+     * The ID of the commentary.
+     */
+    id: string;
+    /**
+     * The name of the commentary.
+     */
+    name: string;
+    /**
+     * The website for the commentary.
+     */
+    website: string;
+    /**
+     * The URL that the license for the commentary can be found.
+     */
+    licenseUrl: string;
+    /**
+     * The english name for the commentary.
+     */
+    englishName: string;
+    /**
+     * The ISO 639 3-letter language tag that the translation is primarily in.
+     */
+    language: string;
+    /**
+     * The direction that the language is written in.
+     * "ltr" indicates that the text is written from the left side of the page to the right.
+     * "rtl" indicates that the text is written from the right side of the page to the left.
+     */
+    textDirection: 'ltr' | 'rtl';
+}
 /**
  * Defines an interface that contains information about a book.
  */
 export interface TranslationBook {
     /**
-     * The ID of the book.
+     * The ID of the book. Should match the USFM book ID.
      */
     id: string;
     /**
@@ -138,6 +183,31 @@ export interface TranslationBook {
      */
     order: number;
 }
+/**
+ * Defines an interface that contains information about a book in a commentary.
+ */
+export interface CommentaryBook {
+    /**
+     * The ID of the book. Should match the USFM book ID.
+     */
+    id: string;
+    /**
+     * The name that the commentary provided for the book.
+     */
+    name: string;
+    /**
+     * The common name for the book.
+     */
+    commonName: string;
+    /**
+     * The commentary's introduction for the book.
+     */
+    introduction?: string;
+    /**
+     * The order of the book in the Bible.
+     */
+    order: number;
+}
 /**
  * Defines an interface that contains information about a book chapter.
  */
@@ -151,6 +221,15 @@ export interface TranslationBookChapter {
      */
     thisChapterAudioLinks: TranslationBookChapterAudioLinks;
 }
+/**
+ * Defines an interface that contains information about a book chapter in a commentary.
+ */
+export interface CommentaryBookChapter {
+    /**
+     * The information for the chapter.
+     */
+    chapter: CommentaryChapterData;
+}
 /**
  * Defines an interface that contains the audio links for a book chapter.
  */
@@ -177,6 +256,24 @@ export interface ChapterData {
      */
     footnotes: ChapterFootnote[];
 }
+/**
+ * Defines an interface that represents data in a chapter in a commentary.
+ */
+export interface CommentaryChapterData {
+    /**
+     * The number of the chapter.
+     */
+    number: number;
+    /**
+     * The introduction that the commentary provided to the chapter.
+     * Not all commentaries provide an introduction to a chapter.
+     */
+    introduction?: string;
+    /**
+     * The content of the chapter.
+     */
+    content: ChapterVerse[];
+}
 /**
  * A union type that represents a single piece of chapter content.
  * A piece of chapter content can be one of the following things: