waha-shared 1.0.1 → 1.0.3

package/functions/scripturePassages.ts

@@ -1,368 +0,0 @@
-import bibleStatuses from '../data/bibleStatuses'
-import {
-  bibleChapters,
-  type BibleChapters,
-} from '../data/typescript/bibleChapters'
-import { numerals } from '../functions/languages'
-import type { LanguageInfo } from '../types/languages'
-
-type BibleChapter = BibleChapters[number]
-
-export interface ScripturePassage {
-  passageId: string
-  bibleId: string
-  header: string
-  verses: BibleChapter['verses'][number][]
-}
-
-/**
- * Parses a verse range string like "GEN.1.1-GEN.1.25" or "JHN.3.16" Returns the
- * start and end verse IDs
- */
-function parseVerseRange(passageId: string): {
-  startBook: string
-  startChapter: string
-  startVerse: string
-  endBook: string
-  endChapter: string
-  endVerse: string
-} {
-  // Handle single verse: "GEN.1.1" -> "GEN.1.1-GEN.1.1"
-  const parts = passageId.includes('-')
-    ? passageId.split('-')
-    : [passageId, passageId]
-
-  const [startBook, startChapter, startVerse] = parts[0].split('.')
-  const [endBook, endChapter, endVerse] = parts[1].split('.')
-
-  return {
-    startBook,
-    startChapter,
-    startVerse,
-    endBook,
-    endChapter,
-    endVerse,
-  }
-}
-
-/** Extracts verses from a chapter based on verse numbers */
-function extractVersesFromChapter(
-  chapter: BibleChapter,
-  startVerse: number,
-  endVerse: number
-): BibleChapter['verses'][number][] {
-  const verses = chapter.verses.filter((verse) => {
-    const verseIdPart = verse.verseId.split('.')[2]
-
-    // Handle verse ranges (e.g., "7-9")
-    if (verseIdPart.includes('-')) {
-      const [rangeStart, rangeEnd] = verseIdPart
-        .split('-')
-        .map((v) => parseInt(v))
-      // Check if the requested range overlaps with this verse range
-      return rangeEnd >= startVerse && rangeStart <= endVerse
-    }
-
-    // Handle single verse numbers
-    const verseNum = parseInt(verseIdPart)
-    return verseNum >= startVerse && verseNum <= endVerse
-  })
-
-  return verses
-}
-
-/**
- * Condenses a list of USFM passage IDs into a readable string format. Groups
- * consecutive passages from the same book together.
- *
- * @example
- *   ["GEN.1.1-GEN.1.25"] -> "Genesis 1: 1-25"
- *   ["GEN.1.1-GEN.1.25", "GEN.2.4-GEN.2.7", "EXO.3.3-EXO.3.25"] -> "Genesis 1: 1-25, 2: 4-7, Exodus 3: 3-25"
- *   ["JHN.1.1"] -> "John 1: 1"
- */
-export function getPassagesString(
-  passageIds: string[] | undefined,
-  language: LanguageInfo
-): string {
-  if (!passageIds || passageIds.length === 0) return ''
-
-  const parts: string[] = []
-  let currentBook: string | null = null
-
-  for (const passageId of passageIds) {
-    const { startBook, startChapter, startVerse, endChapter, endVerse } =
-      parseVerseRange(passageId)
-
-    let bookName: string | undefined =
-      // American sign language should use English book names.
-      language.languageId === 'ase'
-        ? bibleStatuses.BSB.bookNames[startBook]
-        : language.bible.bookNames[startBook]
-    if (!bookName) {
-      bookName = language.bibleFallback?.bookNames[startBook]
-      if (!bookName) continue
-    }
-
-    // New book - include book name
-    if (currentBook !== startBook) {
-      currentBook = startBook
-
-      // Same chapter
-      if (startChapter === endChapter) {
-        if (startVerse === endVerse) {
-          parts.push(`${bookName} ${startChapter}: ${startVerse}`)
-        } else {
-          parts.push(`${bookName} ${startChapter}: ${startVerse}-${endVerse}`)
-        }
-      } else {
-        // Different chapters
-        parts.push(
-          `${bookName} ${startChapter}: ${startVerse}-${endChapter}: ${endVerse}`
-        )
-      }
-    } else {
-      // Same book - omit book name
-      if (startChapter === endChapter) {
-        if (startVerse === endVerse) {
-          parts.push(`${startChapter}: ${startVerse}`)
-        } else {
-          parts.push(`${startChapter}: ${startVerse}-${endVerse}`)
-        }
-      } else {
-        // Different chapters
-        parts.push(`${startChapter}: ${startVerse}-${endChapter}: ${endVerse}`)
-      }
-    }
-  }
-
-  return numerals(parts.join(', '), language.script)
-}
-
-export interface GetChapterParams {
-  chapterId: string
-  bibleId: string
-}
-
-export type GetChapter = (
-  params: GetChapterParams
-) => Promise<BibleChapter | undefined>
-
-interface GetScripturePassageParams {
-  bibleId: string
-  bibleFallbackId: string | undefined
-  passageId: string
-  getChapter: GetChapter
-  languageInfo: LanguageInfo
-}
-
-/**
- * Gets a scripture passage by extracting verses from chapters This is the core
- * parsing logic, independent of the data source
- */
-async function getScripturePassage({
-  bibleId,
-  bibleFallbackId,
-  passageId,
-  getChapter,
-  languageInfo,
-}: GetScripturePassageParams): Promise<ScripturePassage | undefined> {
-  try {
-    const {
-      startBook,
-      startChapter,
-      startVerse,
-      endBook,
-      endChapter,
-      endVerse,
-    } = parseVerseRange(passageId)
-
-    const startVerseNum = parseInt(startVerse)
-    const endVerseNum = parseInt(endVerse)
-
-    // Same chapter - simple case
-    if (startBook === endBook && startChapter === endChapter) {
-      const chapterId = `${startBook}.${startChapter}`
-      let chapter = await getChapter({ chapterId, bibleId })
-
-      if (!chapter && bibleFallbackId)
-        chapter = await getChapter({ chapterId, bibleId: bibleFallbackId })
-
-      if (!chapter) {
-        console.warn(
-          `Chapter not found: ${bibleId}.${chapterId} for passage ${passageId}`
-        )
-        return
-      }
-
-      const verses = extractVersesFromChapter(
-        chapter,
-        startVerseNum,
-        endVerseNum
-      )
-
-      if (verses.length === 0) {
-        console.warn(`No verses found for passage ${passageId}`)
-        return
-      }
-
-      return {
-        passageId,
-        bibleId,
-        header: getPassagesString([passageId], languageInfo),
-        verses,
-      }
-    }
-
-    // Multi-chapter passage (rare but possible)
-    // Example: GEN.1.26-GEN.2.3
-    const chapters: BibleChapter[] = []
-
-    // Get all chapters in the range
-    const startChapterNum = parseInt(startChapter)
-    const endChapterNum = parseInt(endChapter)
-
-    for (let i = startChapterNum; i <= endChapterNum; i++) {
-      const chapterId = `${startBook}.${i}`
-      let chapter = await getChapter({ chapterId, bibleId })
-      if (!chapter && bibleFallbackId)
-        chapter = await getChapter({ chapterId, bibleId: bibleFallbackId })
-
-      if (chapter) {
-        chapters.push(chapter)
-      } else {
-        console.warn(`Missing chapter in range: ${bibleId}.${chapterId}`)
-      }
-    }
-
-    if (chapters.length === 0) {
-      return
-    }
-
-    // Extract verses from each chapter
-    const allVerses: BibleChapter['verses'][number][] = []
-
-    chapters.forEach((chapter, index) => {
-      if (index === 0) {
-        // First chapter - from startVerse to end
-        const lastVerse = Math.max(
-          ...chapter.verses.map((v) => parseInt(v.verseId.split('.')[2]))
-        )
-        allVerses.push(
-          ...extractVersesFromChapter(chapter, startVerseNum, lastVerse)
-        )
-      } else if (index === chapters.length - 1) {
-        // Last chapter - from beginning to endVerse
-        allVerses.push(...extractVersesFromChapter(chapter, 1, endVerseNum))
-      } else {
-        // Middle chapters - all verses
-        allVerses.push(...chapter.verses)
-      }
-    })
-
-    return {
-      passageId,
-      bibleId,
-      header: getPassagesString([passageId], languageInfo),
-      verses: allVerses,
-    }
-  } catch (error) {
-    console.error(
-      `Error getting scripture passage ${passageId} in ${bibleId}`,
-      error
-    )
-    return
-  }
-}
-
-interface GetLessonScriptureParams {
-  bibleId: string
-  bibleFallbackId: string | undefined
-  passageIds: string[]
-  getChapter: (params: GetChapterParams) => Promise<BibleChapter | undefined>
-  languageInfo: LanguageInfo
-}
-
-/**
- * Gets multiple scripture passages efficiently (Future optimization: could
- * batch the chapter fetches)
- */
-export async function getLessonScripture(
-  params: GetLessonScriptureParams
-): Promise<Array<ScripturePassage | undefined>> {
-  const passages = await Promise.all(
-    params.passageIds.map((passageId) =>
-      getScripturePassage({ ...params, passageId })
-    )
-  )
-  return passages
-}
-
-export function parseBibleSnapshot(
-  snapshot: any,
-  bible: string
-): BibleChapters {
-  const validChapters: BibleChapters = []
-
-  if (!snapshot) {
-    console.warn('No snapshot for', bible)
-    return []
-  } else if (snapshot.empty) {
-    console.warn('Empty snapshot for', bible)
-    return []
-  }
-
-  for (const doc of snapshot.docs) {
-    const chapterParse = bibleChapters.element.safeParse(doc.data())
-    if (!chapterParse.success) {
-      console.warn(
-        'Skipping invalid bible chapter document',
-        doc.id,
-        chapterParse.error.issues.map(
-          (i) => `${i.path.join('.')}: ${i.message}`
-        )
-      )
-    } else {
-      validChapters.push(chapterParse.data)
-    }
-  }
-
-  if (validChapters.length === 0) {
-    console.warn('No valid chapters for', bible)
-    return []
-  } else {
-    return validChapters
-  }
-}
-
-/**
- * Converts a verse number to a superscript string. This is useful for
- * displaying verse numbers in a more visually appealing way. For example, "1"
- * becomes "¹", "2" becomes "²", etc
- *
- * @param num The verse number to convert to superscript.
- * @returns The superscript string representation of the verse number.
- */
-export function verseToSuperscript(num: string | undefined) {
-  const superscriptObj = {
-    '0': '⁰',
-    '1': '¹',
-    '2': '²',
-    '3': '³',
-    '4': '⁴',
-    '5': '⁵',
-    '6': '⁶',
-    '7': '⁷',
-    '8': '⁸',
-    '9': '⁹',
-    '-': '⁻',
-  }
-  if (!num) return ''
-  return num
-    .split('')
-    .map((digit) => {
-      if (digit in superscriptObj)
-        return superscriptObj[digit as keyof typeof superscriptObj]
-      else return digit
-    })
-    .join('')
-}