feat: add getRubAlHizb and getRubAlHizbByAyahId methods

Author: husayt

src/getRubAlHizb.ts

@@ -0,0 +1,21 @@
+import { HizbId, Juz, RubAlHizb, JuzPart, RubAlHizbId } from "./types"
+
+/**
+ * Retrieves the basic metadata for a specific quarter (rub' al-hizb) of the Quran.
+ *
+ * @param quarterIndex - The index of the quarter (rub' al-hizb) to retrieve metadata for, where 1 is the first quarter.
+ * @returns An object containing the metadata for the specified quarter, including the juz' (part), hizb (section), and the quarter (rub' al-hizb) index.
+ */
+export function getRubAlHizb(quarterIndex: RubAlHizbId): RubAlHizb {
+  // return HizbQuarterList[maqra]
+
+  // const quarterIndex = HizbQuarterList.findIndex(x => x > ayahId) - 1
+
+  // const juz = findJuzByAyahId(ayahId)
+  const juz = Math.floor((quarterIndex - 1) / 8) + 1 as Juz
+  // isValidJuz(juz)
+
+  const hizbIndex = Math.floor((quarterIndex - 1) / 4) + 1 as HizbId
+  const juzPart = (quarterIndex % 8 || 8) as JuzPart
+  return { juz, hizbId: hizbIndex, juzPart, rubAlHizbId: quarterIndex }
+}

src/getRubAlHizbByAyahId.ts

@@ -0,0 +1,17 @@
+import { findRubAlHizbByAyahId } from "./findRubAlHizbByAyahId"
+import { getRubAlHizb } from "./getRubAlHizb"
+import { AyahId, RubAlHizb } from "./types"
+import { checkValidAyahId } from "./validation"
+
+/**
+ * Finds the Juz, Hizb, and Rub-el-Hizb id for the given Ayah ID.
+ *
+ * @param ayahId - The Ayah ID to find the Juz, Hizb, and Hizb ID for.
+ * @returns An object containing the Juz, Hizb, and Hizb ID for the given Ayah ID.
+ */
+export function getRubAlHizbByAyahId(ayahId: AyahId): RubAlHizb {
+  checkValidAyahId(ayahId)
+
+  const quarterIndex = findRubAlHizbByAyahId(ayahId)
+  return getRubAlHizb(quarterIndex)
+}