quran-meta/src/findRangeAroundSurahAyah.ts

Library with meta data and functionality related to Holy Quran

import { findAyahIdBySurah } from "./findAyahIdBySurah"
import { findRangeAroundAyah } from "./findRangeAroundAyah"
import type { RiwayaData } from "./lists/types"
import type { AyahId, AyahNo, AyahRange, RangeMode, Surah } from "./types"
import { checkValidSurah } from "./validation"

/**
 * Finds a range of ayahs around a given ayah based on the specified mode.
 *
 * @param surah - The surah number (1-114)
 * @param ayah - The ayah number within the surah
 * @param mode - The range mode: "juz", "surah", "ayah", "page", "ruku" or "all"
 * @param lists - The Lists object for the riwaya.
 * @returns A tuple containing the start and end ayah IDs of the range
 */
export function findRangeAroundSurahAyah(
  surah: Surah,
  ayah: AyahNo,
  mode: RangeMode,
  data: RiwayaData
): AyahRange {
  checkValidSurah(surah, data.meta)
  const SurahList = data.SurahList
  if (mode === "surah") {
    return [SurahList[surah][0], SurahList[surah + 1][0] - 1]
  }
  const ayahId: AyahId = findAyahIdBySurah(surah, ayah, data)
  return findRangeAroundAyah(ayahId, mode, data)
}