full refactor of the library

Author: husayt

src/ayaStringSplitter.ts

@@ -1,5 +1,5 @@
-import { checkValidSurahAyah } from "./checkValidSurahAyah"
 import { AyahNo, SurahAyahSegment } from "./types"
+import { checkValidSurahAyah } from "./validation"
 
 /**
  *  Turns String of type "x:y" or "x:y1-y2" to array [x,y] or [x,[y1,y2]] respectively
@@ -20,22 +20,22 @@ export function ayaStringSplitter(str: string): SurahAyahSegment {
 
   let ayahs: AyahNo | [AyahNo, AyahNo]
   if (ayahsStr.includes("-")) {
-    ayahs = ayahsStr.split("-").map(a => {
+    ayahs = ayahsStr.split("-").map((a) => {
       const ayah = parseInt(a, 10)
       if (isNaN(ayah) || ayah === 0) {
         throw "Error in ayah " + a
       }
       return ayah
     }) as [AyahNo, AyahNo]
     if (ayahs[0] > ayahs[1]) throw "Error in ayah range " + str
-  } else {
+  }
+  else {
     ayahs = parseInt(ayahsStr, 10)
-    if (isNaN(ayahs)|| ayahs === 0) {
+    if (isNaN(ayahs) || ayahs === 0) {
       throw "Error in data " + str
     }
     checkValidSurahAyah(surah, ayahs)
   }
 
-
   return [surah, ayahs]
 }

src/checkValidAyahId.ts

@@ -11,5 +11,5 @@ export const meta: Readonly<QuranMeta> = Object.freeze({
   numSuras: 114,
   numPages: 604,
   numJuzs: 30,
-  manzilCount: 7,
+  manzilCount: 7
 })

src/checkValidSurah.ts

@@ -1,6 +1,6 @@
-import { checkValidSurahAyah } from "./checkValidSurahAyah";
-import { getSurahMeta } from "./getSurahMeta";
-import { AyahId, AyahNo, Surah } from "./types";
+import { getSurahMeta } from "./getSurahMeta"
+import { AyahId, AyahNo, Surah } from "./types"
+import { checkValidSurahAyah } from "./validation"
 
 /**
  * Get the ayah ID for the given surah and ayah number.
@@ -9,7 +9,7 @@ import { AyahId, AyahNo, Surah } from "./types";
  * @returns The ayah ID for the given surah and ayah number.
  */
 export function findAyaidBySurah(surah: Surah, ayah: AyahNo): AyahId {
-  checkValidSurahAyah(surah, ayah);
-  const [startAyahId] = getSurahMeta(surah);
-  return startAyahId + ayah;
+  checkValidSurahAyah(surah, ayah)
+  const [startAyahId] = getSurahMeta(surah)
+  return startAyahId + ayah
 }

src/checkValidSurahAyah.ts

@@ -1,7 +1,7 @@
-import { checkValidSurahAyah } from "./checkValidSurahAyah";
-import { findAyaidBySurah } from "./findAyaidBySurah";
-import { findJuzByAyaid } from "./findJuzByAyaid";
-import { AyahId, AyahNo, Juz, Surah } from "./types";
+import { findAyaidBySurah } from "./findAyaidBySurah"
+import { findJuzByAyaid } from "./findJuzByAyaid"
+import { AyahId, AyahNo, Juz, Surah } from "./types"
+import { checkValidSurahAyah } from "./validation"
 
 /**
  * Finds the Juz (part) of the Quran that the given Ayah (verse) belongs to.
@@ -14,7 +14,8 @@ import { AyahId, AyahNo, Juz, Surah } from "./types";
 export function findJuz(surah: Surah, ayah: AyahNo = 1, ayahMode = false): Juz {
   const ayahId: AyahId = ayahMode
     ? ayah
-    : ((checkValidSurahAyah(surah, ayah) && findAyaidBySurah(surah, ayah)) as AyahId);
+    : ((checkValidSurahAyah(surah, ayah)
+      && findAyaidBySurah(surah, ayah)) as AyahId)
 
-  return findJuzByAyaid(ayahId);
+  return findJuzByAyaid(ayahId)
 }

src/const.ts

@@ -1,12 +1,10 @@
-import { checkValidAyahId } from "./checkValidAyahId";
-import { checkValidSurah } from "./checkValidSurah";
-import { findAyaidBySurah } from "./findAyaidBySurah";
-import { findJuzByAyaid } from "./findJuzByAyaid";
-import { findSurahByAyaid } from "./findSurahByAyaid";
-import { JuzList } from "./lists/juzList";
-import { SuraList } from "./lists/surahList";
-import { AyahId, AyahNo, Juz, Surah } from "./types";
-
+import { findAyaidBySurah } from "./findAyaidBySurah"
+import { findJuzByAyaid } from "./findJuzByAyaid"
+import { findSurahByAyaid } from "./findSurahByAyaid"
+import { JuzList } from "./lists/juzList"
+import { SuraList } from "./lists/surahList"
+import { AyahId, AyahNo, Juz, Surah } from "./types"
+import { checkValidAyahId, checkValidSurah } from "./validation"
 
 /**
  * Finds the juz (section) that contains the specified ayah (verse) and calculates the number of ayahs between the start of the juz and the start of the surah (chapter) that contains the ayah.
@@ -24,21 +22,21 @@ export function findJuzAndShift(
   ayah: AyahNo,
   ayahMode = false
 ): {
-  juz: Juz;
-  leftAyahId: AyahId;
-  ayahsBetweenJuzSurah: number;
-} {
+    juz: Juz
+    leftAyahId: AyahId
+    ayahsBetweenJuzSurah: number
+  } {
   const ayahId: AyahId = ayahMode
     ? ((checkValidAyahId(ayah) && ayah) as AyahId)
-    : ((checkValidSurah(surah) && findAyaidBySurah(surah, ayah)) as AyahId);
+    : ((checkValidSurah(surah) && findAyaidBySurah(surah, ayah)) as AyahId)
 
-  const juz = findJuzByAyaid(ayahId);
-  const leftAyahId = JuzList[juz];
-  if (ayahMode) [surah] = findSurahByAyaid(ayahId);
-  const [surahStartAyahId] = SuraList[surah];
+  const juz = findJuzByAyaid(ayahId)
+  const leftAyahId = JuzList[juz]
+  if (ayahMode) [surah] = findSurahByAyaid(ayahId)
+  const [surahStartAyahId] = SuraList[surah]
   return {
     juz,
     ayahsBetweenJuzSurah: surahStartAyahId - leftAyahId + 1,
     leftAyahId
-  };
+  }
 }

src/findAyaidBySurah.ts

@@ -1,7 +1,6 @@
-import { checkValidAyahId } from "./checkValidAyahId";
-import { JuzList } from "./lists/juzList";
-import { AyahId, Juz } from "./types";
-
+import { JuzList } from "./lists/juzList"
+import { AyahId, Juz } from "./types"
+import { checkValidAyahId } from "./validation"
 
 /**
  * Finds the Juz (part) of the Quran that contains the given Ayah (verse) ID.
@@ -10,7 +9,7 @@ import { AyahId, Juz } from "./types";
  * @returns The Juz (part) of the Quran that contains the given Ayah ID.
  */
 export function findJuzByAyaid(ayaId: AyahId): Juz {
-  checkValidAyahId(ayaId);
+  checkValidAyahId(ayaId)
 
-  return JuzList.findIndex(x => x > ayaId) - 1;
+  return JuzList.findIndex(x => x > ayaId) - 1
 }

src/findJuz.ts

@@ -1,7 +1,7 @@
-import { checkValidSurah } from "./checkValidSurah";
-import { findAyaidBySurah } from "./findAyaidBySurah";
-import { findJuzHizbByAyaid } from "./findJuzHizbByAyaid";
-import { AyahId, AyahNo, JuzHizb, Surah } from "./types";
+import { findAyaidBySurah } from "./findAyaidBySurah"
+import { findJuzHizbByAyaid } from "./findJuzHizbByAyaid"
+import { AyahId, AyahNo, JuzHizb, Surah } from "./types"
+import { checkValidSurah } from "./validation"
 
 /**
  * Finds the Juz (part) and Hizb (section) of the Quran that the given Ayah (verse) belongs to.
@@ -18,7 +18,7 @@ export function findJuzHizb(
 ): JuzHizb {
   const ayahId: AyahId = ayahMode
     ? ayah
-    : ((checkValidSurah(surah) && findAyaidBySurah(surah, ayah)) as AyahId);
+    : ((checkValidSurah(surah) && findAyaidBySurah(surah, ayah)) as AyahId)
 
-  return findJuzHizbByAyaid(ayahId);
+  return findJuzHizbByAyaid(ayahId)
 }

src/findJuzAndShift.ts

@@ -1,8 +1,7 @@
-import { checkValidAyahId } from "./checkValidAyahId";
-import { findJuzByAyaid } from "./findJuzByAyaid";
-import { HizbQuarterList } from "./lists/hizbList";
-import { AyahId, JuzHizb } from "./types";
-
+import { findJuzByAyaid } from "./findJuzByAyaid"
+import { HizbQuarterList } from "./lists/hizbList"
+import { AyahId, JuzHizb } from "./types"
+import { checkValidAyahId } from "./validation"
 
 /**
  * Finds the Juz, Hizb, and Hizb ID for the given Ayah ID.
@@ -11,10 +10,13 @@ import { AyahId, JuzHizb } from "./types";
  * @returns An object containing the Juz, Hizb, and Hizb ID for the given Ayah ID.
  */
 export function findJuzHizbByAyaid(ayaId: AyahId): JuzHizb {
-  checkValidAyahId(ayaId);
-
-  const juz = findJuzByAyaid(ayaId);
+  checkValidAyahId(ayaId)
 
-  const id = HizbQuarterList.findIndex(x => x > ayaId) - 1;
-  return { juz, hizb: id % 8 || 8, id };
+  const juz = findJuzByAyaid(ayaId)
+  const quarterIndex = HizbQuarterList.findIndex(x => x > ayaId) - 1
+  if (quarterIndex < 0) {
+    throw new Error("Invalid Ayah ID: No corresponding Hizb found.")
+  }
+  const hizb = quarterIndex % 8 || 8
+  return { juz, hizb, id: quarterIndex }
 }

src/findJuzByAyaid.ts

@@ -1,30 +1,35 @@
-import { meta } from "./const";
-import { findJuzAndShift } from "./findJuzAndShift";
-import { findSurahByAyaid } from "./findSurahByAyaid";
-import { JuzList } from "./lists/juzList";
-import { AyahNo, Juz, JuzMeta, Surah } from "./types";
+import { meta } from "./const"
+import { findJuzAndShift } from "./findJuzAndShift"
+import { findSurahByAyaid } from "./findSurahByAyaid"
+import { JuzList } from "./lists/juzList"
+import { AyahNo, Juz, JuzMeta, Surah } from "./types"
 
 /**
  * for given ayah return [starting juz, number of ayahsFrom beginning of that juz, right juz, number of ayahs in surah
- * @param {*} suraNumber
- * @param {*} ayaNumber
+ * @param suraNumber
+ * @param ayaNumber
  * @returns [leftjuz, ayahsFromStartOfJuz, rightJuz, ayahsinSurah,leftAyahId,rightAyahId]
  */
 export function findJuzMetaBySurah(surah: Surah, ayah: AyahNo = 1): JuzMeta {
   const {
-    juz: leftjuz, ayahsBetweenJuzSurah, leftAyahId,
-  } = findJuzAndShift(surah, ayah);
+    juz: leftjuz,
+    ayahsBetweenJuzSurah,
+    leftAyahId
+  } = findJuzAndShift(surah, ayah)
 
-  let rightJuz: Juz = leftjuz;
-  while (rightJuz < meta.numJuzs &&
-    findSurahByAyaid(JuzList[rightJuz + 1])[0] == surah)
-    rightJuz++;
+  let rightJuz: Juz = leftjuz
+  while (
+    rightJuz < meta.numJuzs
+    && findSurahByAyaid(JuzList[rightJuz + 1])[0] === surah
+  ) {
+    rightJuz++
+  }
 
   return {
     leftjuz,
     ayahsBetweenJuzSurah,
     rightJuz,
     leftAyahId,
-    rightAyahId: JuzList[rightJuz + 1],
-  };
+    rightAyahId: JuzList[rightJuz + 1]
+  }
 }

src/findJuzHizb.ts

@@ -1,9 +1,7 @@
-import { checkValidAyahId } from "./checkValidAyahId";
-import { checkValidSurah } from "./checkValidSurah";
-import { findAyaidBySurah } from "./findAyaidBySurah";
-import { PageList } from "./lists/pageList";
-import { AyahId, AyahNo, Page, Surah } from "./types";
-
+import { findAyaidBySurah } from "./findAyaidBySurah"
+import { PageList } from "./lists/pageList"
+import { AyahId, AyahNo, Page, Surah } from "./types"
+import { checkValidAyahId, checkValidSurah } from "./validation"
 
 /**
  * Finds the page number for the given Surah and Ayah number.
@@ -16,7 +14,7 @@ import { AyahId, AyahNo, Page, Surah } from "./types";
 export function findPage(surah: Surah, ayah: AyahNo, ayahMode = false): Page {
   const ayahId: AyahId = ayahMode
     ? ((checkValidAyahId(ayah) && ayah) as AyahId)
-    : ((checkValidSurah(surah) && findAyaidBySurah(surah, ayah)) as AyahId);
+    : ((checkValidSurah(surah) && findAyaidBySurah(surah, ayah)) as AyahId)
 
-  return PageList.findIndex(x => x > ayahId) - 1;
+  return PageList.findIndex(x => x > ayahId) - 1
 }