feat: exposed findJuzAndShift, findJuzAndShiftByAyahId, getJuzMeta, getRubAlHizb, getRubAlHizbByAyahId

Author: husayt

src/findRangeAroundAyah.ts

@@ -7,7 +7,7 @@ import { JuzList } from "./lists/juzList"
 import { PageList } from "./lists/pageList"
 import { RukuList } from "./lists/rukuList"
 import { SurahList } from "./lists/surahList"
-import { AyahId, AyahRange, Juz, Page, Ruku, Surah } from "./types"
+import { AyahId, AyahRange, Juz, Page, RangeMode, Ruku, Surah } from "./types"
 
 /**
  * Finds the range of ayahs surrounding a given ayah based on specified mode
@@ -23,7 +23,7 @@ import { AyahId, AyahRange, Juz, Page, Ruku, Surah } from "./types"
  */
 export function findRangeAroundAyah(
   ayahId: AyahId,
-  mode: "juz" | "surah" | "ayah" | "page" | "ruku" | "all"
+  mode: RangeMode
 ): AyahRange {
   switch (mode) {
     case "juz": {

src/findRangeAroundSurahAyah.ts

@@ -1,7 +1,7 @@
 import { findAyahIdBySurah } from "./findAyahIdBySurah"
 import { findRangeAroundAyah } from "./findRangeAroundAyah"
 import { SurahList } from "./lists/surahList"
-import { AyahId, AyahNo, AyahRange, Surah } from "./types"
+import { AyahId, AyahNo, AyahRange, RangeMode, Surah } from "./types"
 import { checkValidSurah } from "./validation"
 
 /**
@@ -15,7 +15,7 @@ import { checkValidSurah } from "./validation"
 export function findRangeAroundSurahAyah(
   surah: Surah,
   ayah: AyahNo,
-  mode: "juz" | "surah" | "ayah" | "page" | "all"
+  mode: RangeMode
 ): AyahRange {
   checkValidSurah(surah)
   if (mode === "surah") {

src/getAyahMeta.ts

@@ -1,6 +1,6 @@
 import { findPagebyAyahId } from "./findPagebyAyahId"
 import { findSurahAyahByAyahId } from "./findSurahAyahByAyahId"
-import { getRubAlHizbMetaByAyahId } from "./getRubAlHizbMetaByAyahId"
+import { getRubAlHizbByAyahId } from "./getRubAlHizbByAyahId"
 import { HizbQuarterList } from "./lists/hizbQuarterList"
 import { JuzList } from "./lists/juzList"
 import { PageList } from "./lists/pageList"
@@ -21,7 +21,7 @@ import { checkValidAyahId } from "./validation"
 export function getAyahMeta(ayahId: AyahId): AyahMeta {
   checkValidAyahId(ayahId)
 
-  const quarterData = getRubAlHizbMetaByAyahId(ayahId)
+  const quarterData = getRubAlHizbByAyahId(ayahId)
   const [surah, ayah] = findSurahAyahByAyahId(ayahId)
   const page: Page = findPagebyAyahId(ayahId)
 

src/getJuzMeta.ts

@@ -1,6 +1,6 @@
 import { findSurahAyahByAyahId } from "./findSurahAyahByAyahId"
 import { JuzList } from "./lists/juzList"
-import { AyahId, JuzMeta } from "./types"
+import { AyahId, Juz, JuzMeta } from "./types"
 import { checkValidJuz } from "./validation"
 
 /**
@@ -10,7 +10,7 @@ import { checkValidJuz } from "./validation"
  * @returns An object containing the Juz number, first ayah, and last ayah in the Juz
  * @throws RangeError If the Juz number is not between 1 and 30
  */
-export function getJuzMeta(juzNum: number): JuzMeta {
+export function getJuzMeta(juzNum: Juz): JuzMeta {
   checkValidJuz(juzNum)
 
   const [firstAyahId, nextJuzAyahId]: [AyahId, AyahId] = [

src/index.ts

@@ -1,14 +1,14 @@
 // Quran Meta
 
 export type { QuranMeta } from "./const"
-export type { AyahCountBetweenJuzSurah, AyahId, AyahMeta, AyahNo, AyahRange, HizbId, Juz, JuzHizb, SurahJuzMeta, JuzPart, Manzil, Page, PageMeta, RubAlHizbId, Ruku, Sajda, SajdaType, Surah, SurahAyah, SurahAyahSegment, SurahMeta, SurahName } from "./types"
+export type { AyahCountBetweenJuzSurah, JuzMeta, AyahId, AyahMeta, AyahNo, AyahRange, HizbId, Juz, RubAlHizb, RubAlHizbMeta, SurahJuzMeta, JuzPart, Manzil, Page, PageMeta, RubAlHizbId, Ruku, Sajda, SajdaType, Surah, SurahAyah, SurahAyahSegment, SurahMeta, SurahName } from "./types"
 
 export { ayahStringSplitter, string2NumberSplitter, string2NumberSplitterStrict } from "./ayahStringSplitter"
 export { surahStringParser } from "./surahStringParser"
 export { meta } from "./const"
 export { findAyahIdBySurah } from "./findAyahIdBySurah"
 export { findJuz } from "./findJuz"
-export { findJuzAndShift } from "./findJuzAndShift"
+export { findJuzAndShift, findJuzAndShiftByAyahId } from "./findJuzAndShift"
 export { findJuzByAyahId } from "./findJuzByAyahId"
 export { findJuzMetaBySurah } from "./findJuzMetaBySurah"
 export { findPage } from "./findPage"
@@ -23,11 +23,14 @@ export { findSurahByAyahId } from "./findSurahByAyahId"
 export { getAyahCountInSurah } from "./getAyahCountInSurah"
 export { getAyahMeta } from "./getAyahMeta"
 export { getAyahMetasForSurah } from "./getAyahMetasForSurah"
+export { getJuzMeta } from "./getJuzMeta"
 export { getList } from "./getList"
 export { getPageMeta } from "./getPageMeta"
 export { getRukuMeta } from "./getRukuMeta"
+export { getRubAlHizb } from "./getRubAlHizb"
 export { getRubAlHizbMeta } from "./getRubAlHizbMeta"
 export { getRubAlHizbMetaByAyahId } from "./getRubAlHizbMetaByAyahId"
+export { getRubAlHizbByAyahId } from "./getRubAlHizbByAyahId"
 export { getSurahMeta } from "./getSurahMeta"
 export { isAyahJuzFirst } from "./isAyahJuzFirst"
 export { isAyahPageFirst } from "./isAyahPageFirst"

src/types.ts

@@ -83,26 +83,29 @@ export type Juz = NumericRange<0, typeof meta.numJuzs>
  */
 export type JuzPart = NumericRange<1, typeof meta.numRubsInJuz>
 
+export type RangeMeta = {
+  firstAyahId: AyahId
+  lastAyahId: AyahId
+  first: SurahAyah
+  last: SurahAyah
+}
+
 /**
  * Represents the structure of a Juz and Hizb combination in the Quran
  */
-export type JuzHizb = {
+export type RubAlHizb = {
   juz: Juz
   juzPart: JuzPart
   hizbId: HizbId
   rubAlHizbId: RubAlHizbId
 }
+
+export type RubAlHizbMeta = RubAlHizb & RangeMeta
+
 export type SurahAyah = [Surah, AyahNo]
 export type AyahRange = [AyahId, AyahId]
 export type SurahAyahSegment = [Surah, AyahNo | [AyahNo, AyahNo]]
 
-export type RangeMeta = {
-  firstAyahId: AyahId
-  lastAyahId: AyahId
-  first: SurahAyah
-  last: SurahAyah
-}
-
 export type PageMeta = {
   pageNum: Page
 } & RangeMeta
@@ -139,6 +142,8 @@ export type SurahMeta = [
 ]
 export type SurahName = [name: string, translitName: string]
 
+export type RangeMode = "juz" | "surah" | "ayah" | "page" | "ruku" | "all"
+
 export type AyahMeta = {
   juz: Juz
   juzPart: JuzPart // 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8