quran-meta/src/lists/HafsLists.ts

Library with meta data and functionality related to Holy Quran

import type { AyahId, QuranMeta, SurahInfo } from "../types"
import type { FixedArray } from "../ts-utils"

// ------------------ Hizb Quarter (Rub-ul-Hizb) Data ---------------------
export const HizbQuarterList: AyahId[] = [
  0, 1, 33, 51, 67, 82, 99, 113, 131, 149, 165, 184, 196, 210, 226, 240, 250,
  260, 270, 279, 290, 308, 326, 345, 368, 386, 406, 426, 446, 464, 479, 494,
  505, 517, 529, 551, 567, 581, 593, 607, 628, 641, 656, 670, 681, 696, 710,
  720, 736, 751, 766, 778, 802, 825, 848, 863, 884, 900, 916, 930, 940, 955,
  985, 1001, 1019, 1042, 1071, 1096, 1110, 1125, 1143, 1161, 1182, 1201, 1221,
  1236, 1254, 1269, 1281, 1295, 1310, 1328, 1346, 1357, 1375, 1390, 1417, 1435,
  1454, 1479, 1497, 1514, 1534, 1557, 1581, 1603, 1626, 1649, 1673, 1697, 1712,
  1726, 1742, 1760, 1778, 1803, 1852, 1902, 1931, 1952, 1976, 1991, 2012, 2030,
  2052, 2079, 2099, 2128, 2157, 2172, 2191, 2215, 2239, 2272, 2309, 2349, 2403,
  2431, 2459, 2484, 2512, 2534, 2566, 2596, 2614, 2633, 2655, 2674, 2709, 2748,
  2792, 2812, 2826, 2844, 2856, 2876, 2908, 2933, 2984, 3043, 3113, 3160, 3186,
  3215, 3241, 3264, 3281, 3303, 3328, 3341, 3366, 3386, 3410, 3440, 3463, 3491,
  3514, 3534, 3551, 3564, 3584, 3593, 3616, 3630, 3652, 3675, 3701, 3733, 3765,
  3810, 3871, 3933, 3991, 4022, 4066, 4090, 4111, 4134, 4154, 4174, 4199, 4227,
  4243, 4265, 4285, 4299, 4323, 4349, 4382, 4431, 4485, 4511, 4531, 4555, 4578,
  4601, 4613, 4626, 4657, 4706, 4759, 4810, 4855, 4902, 4980, 5054, 5091, 5105,
  5118, 5137, 5157, 5178, 5192, 5218, 5230, 5242, 5272, 5324, 5394, 5448, 5495,
  5552, 5610, 5673, 5759, 5830, 5885, 5949, 6024, 6091, 6155, 6237
] as const

// ------------------ Juz Data ---------------------
export const JuzList: AyahId[] = [
  0, 1, 149, 260, 386, 517, 641, 751, 900, 1042, 1201, 1328, 1479, 1649, 1803,
  2030, 2215, 2484, 2674, 2876, 3215, 3386, 3564, 3733, 4090, 4265, 4511, 4706,
  5105, 5242, 5673, 6237
] as const

// ------------------ Manzil Data ---------------------
export const ManzilList: AyahId[] = [
  0, 1, 670, 1365, 2030, 2933, 3789, 4631, 6237
] as const

// ------------------ Page Data ---------------------
export const PageList: AyahId[] = [
  0, 1, 8, 13, 24, 32, 37, 45, 56, 65, 69, 77, 84, 91, 96, 101, 109, 113, 120,
  127, 134, 142, 149, 153, 161, 171, 177, 184, 189, 194, 198, 204, 210, 218,
  223, 227, 232, 238, 241, 245, 253, 256, 260, 264, 267, 272, 277, 282, 289,
  290, 294, 303, 309, 316, 323, 331, 339, 346, 355, 364, 371, 377, 385, 394,
  402, 409, 415, 426, 434, 442, 447, 451, 459, 467, 474, 480, 488, 494, 500,
  505, 508, 513, 517, 520, 527, 531, 538, 545, 553, 559, 568, 573, 580, 585,
  588, 595, 599, 607, 615, 621, 628, 634, 641, 648, 656, 664, 669, 672, 675,
  679, 683, 687, 693, 701, 706, 711, 715, 720, 727, 734, 740, 746, 752, 759,
  765, 773, 778, 783, 790, 798, 808, 817, 825, 834, 842, 849, 858, 863, 871,
  880, 884, 891, 900, 908, 914, 921, 927, 932, 936, 941, 947, 955, 966, 977,
  985, 992, 998, 1006, 1012, 1022, 1028, 1036, 1042, 1050, 1059, 1075, 1085,
  1092, 1098, 1104, 1110, 1114, 1118, 1125, 1133, 1142, 1150, 1161, 1169, 1177,
  1186, 1194, 1201, 1206, 1213, 1222, 1230, 1236, 1242, 1249, 1256, 1262, 1267,
  1272, 1276, 1283, 1290, 1297, 1304, 1308, 1315, 1322, 1329, 1335, 1342, 1347,
  1353, 1358, 1365, 1371, 1379, 1385, 1390, 1398, 1407, 1418, 1426, 1435, 1443,
  1453, 1462, 1471, 1479, 1486, 1493, 1502, 1511, 1519, 1527, 1536, 1545, 1555,
  1562, 1571, 1582, 1591, 1601, 1611, 1619, 1627, 1634, 1640, 1649, 1660, 1666,
  1675, 1683, 1692, 1700, 1708, 1713, 1721, 1726, 1736, 1742, 1750, 1756, 1761,
  1769, 1775, 1784, 1793, 1803, 1818, 1834, 1854, 1873, 1893, 1908, 1916, 1928,
  1936, 1944, 1956, 1966, 1974, 1981, 1989, 1995, 2004, 2012, 2020, 2030, 2037,
  2047, 2057, 2068, 2079, 2088, 2096, 2105, 2116, 2126, 2134, 2145, 2156, 2161,
  2168, 2175, 2186, 2194, 2202, 2215, 2224, 2238, 2251, 2262, 2276, 2289, 2302,
  2315, 2327, 2346, 2361, 2386, 2400, 2413, 2425, 2436, 2447, 2462, 2474, 2484,
  2494, 2508, 2519, 2528, 2541, 2556, 2565, 2574, 2585, 2596, 2601, 2611, 2619,
  2626, 2634, 2642, 2651, 2660, 2668, 2674, 2691, 2701, 2716, 2733, 2748, 2763,
  2778, 2792, 2802, 2812, 2819, 2823, 2828, 2835, 2845, 2850, 2853, 2858, 2867,
  2876, 2888, 2899, 2911, 2923, 2933, 2952, 2972, 2993, 3016, 3044, 3069, 3092,
  3116, 3139, 3160, 3173, 3182, 3195, 3204, 3215, 3223, 3236, 3248, 3258, 3266,
  3274, 3281, 3288, 3296, 3303, 3312, 3323, 3330, 3337, 3347, 3355, 3364, 3371,
  3379, 3386, 3393, 3404, 3415, 3425, 3434, 3442, 3451, 3460, 3470, 3481, 3489,
  3498, 3504, 3515, 3524, 3534, 3540, 3549, 3556, 3564, 3569, 3577, 3584, 3588,
  3596, 3607, 3614, 3621, 3629, 3638, 3646, 3655, 3664, 3672, 3679, 3691, 3699,
  3705, 3718, 3733, 3746, 3760, 3776, 3789, 3813, 3840, 3865, 3891, 3915, 3942,
  3971, 3987, 3997, 4013, 4032, 4054, 4064, 4069, 4080, 4090, 4099, 4106, 4115,
  4126, 4133, 4141, 4150, 4159, 4167, 4174, 4183, 4192, 4200, 4211, 4219, 4230,
  4239, 4248, 4257, 4265, 4273, 4283, 4288, 4295, 4304, 4317, 4324, 4336, 4348,
  4359, 4373, 4386, 4399, 4415, 4433, 4454, 4474, 4487, 4496, 4506, 4516, 4525,
  4531, 4539, 4546, 4557, 4565, 4575, 4584, 4593, 4599, 4607, 4612, 4617, 4624,
  4631, 4646, 4666, 4682, 4706, 4727, 4750, 4767, 4785, 4811, 4829, 4853, 4874,
  4896, 4918, 4942, 4969, 4996, 5030, 5056, 5079, 5087, 5094, 5100, 5105, 5111,
  5116, 5126, 5130, 5136, 5143, 5151, 5156, 5162, 5169, 5178, 5186, 5193, 5200,
  5209, 5218, 5223, 5230, 5237, 5242, 5254, 5268, 5287, 5314, 5332, 5358, 5386,
  5415, 5430, 5448, 5461, 5476, 5495, 5513, 5543, 5571, 5597, 5617, 5642, 5673,
  5703, 5728, 5759, 5801, 5830, 5855, 5883, 5910, 5932, 5964, 5994, 6017, 6044,
  6073, 6099, 6126, 6138, 6156, 6177, 6194, 6208, 6222, 6237
] as const

// ------------------ Ruku Data ---------------------
export const RukuList: AyahId[] = [
  0, 1, 8, 15, 28, 37, 47, 54, 67, 69, 79, 90, 94, 104, 111, 120, 129, 137, 149,
  155, 160, 171, 175, 184, 190, 196, 204, 218, 224, 229, 236, 239, 243, 250,
  256, 261, 265, 268, 274, 281, 289, 291, 294, 303, 314, 324, 335, 348, 357,
  365, 374, 385, 395, 403, 414, 423, 437, 442, 449, 465, 474, 483, 494, 504,
  508, 516, 519, 527, 536, 544, 553, 564, 570, 581, 585, 590, 594, 598, 606,
  609, 620, 628, 635, 646, 656, 665, 670, 675, 681, 689, 696, 704, 713, 720,
  726, 736, 747, 756, 763, 770, 778, 785, 790, 800, 810, 820, 831, 840, 845,
  850, 860, 872, 880, 884, 890, 900, 911, 919, 930, 934, 940, 944, 955, 965,
  980, 986, 994, 1002, 1008, 1013, 1019, 1027, 1039, 1048, 1054, 1063, 1081,
  1084, 1096, 1102, 1106, 1112, 1117, 1126, 1136, 1143, 1161, 1171, 1180, 1189,
  1198, 1205, 1209, 1219, 1225, 1230, 1236, 1242, 1252, 1260, 1265, 1273, 1278,
  1295, 1302, 1308, 1316, 1325, 1335, 1346, 1354, 1358, 1365, 1375, 1385, 1395,
  1405, 1418, 1425, 1435, 1447, 1457, 1468, 1474, 1482, 1498, 1509, 1523, 1534,
  1542, 1557, 1569, 1583, 1597, 1603, 1617, 1626, 1632, 1639, 1646, 1654, 1665,
  1676, 1690, 1701, 1708, 1715, 1726, 1734, 1739, 1745, 1751, 1757, 1763, 1772,
  1778, 1785, 1792, 1803, 1818, 1828, 1847, 1863, 1882, 1902, 1911, 1923, 1927,
  1936, 1942, 1952, 1962, 1967, 1972, 1978, 1985, 1991, 2002, 2012, 2021, 2030,
  2040, 2052, 2060, 2070, 2082, 2090, 2100, 2107, 2114, 2123, 2130, 2141, 2153,
  2158, 2163, 2172, 2185, 2190, 2194, 2200, 2211, 2223, 2242, 2251, 2266, 2291,
  2301, 2316, 2333, 2349, 2373, 2403, 2425, 2438, 2453, 2464, 2477, 2484, 2494,
  2513, 2525, 2534, 2559, 2577, 2596, 2606, 2618, 2621, 2629, 2634, 2644, 2653,
  2660, 2668, 2674, 2696, 2706, 2724, 2751, 2766, 2792, 2802, 2812, 2818, 2826,
  2832, 2842, 2849, 2853, 2856, 2865, 2876, 2890, 2900, 2916, 2933, 2942, 2966,
  2985, 3002, 3037, 3055, 3073, 3092, 3108, 3124, 3160, 3174, 3191, 3204, 3218,
  3226, 3242, 3253, 3266, 3274, 3281, 3295, 3303, 3313, 3328, 3341, 3354, 3363,
  3371, 3385, 3392, 3404, 3410, 3420, 3429, 3437, 3450, 3463, 3470, 3481, 3489,
  3504, 3515, 3526, 3534, 3542, 3554, 3561, 3568, 3574, 3586, 3592, 3602, 3607,
  3616, 3628, 3637, 3643, 3652, 3661, 3668, 3675, 3687, 3698, 3706, 3718, 3738,
  3756, 3773, 3789, 3810, 3863, 3902, 3927, 3971, 3985, 3997, 4011, 4035, 4059,
  4068, 4080, 4090, 4100, 4111, 4122, 4129, 4134, 4143, 4154, 4161, 4171, 4184,
  4194, 4202, 4212, 4219, 4227, 4237, 4244, 4251, 4263, 4273, 4282, 4292, 4302,
  4316, 4326, 4341, 4351, 4361, 4371, 4382, 4393, 4415, 4444, 4457, 4474, 4485,
  4495, 4500, 4511, 4521, 4531, 4537, 4546, 4557, 4565, 4574, 4584, 4594, 4601,
  4610, 4613, 4623, 4631, 4646, 4660, 4676, 4699, 4722, 4736, 4764, 4785, 4810,
  4817, 4847, 4869, 4887, 4902, 4927, 4947, 4980, 5018, 5054, 5076, 5086, 5095,
  5101, 5105, 5111, 5118, 5127, 5137, 5144, 5151, 5157, 5164, 5173, 5178, 5186,
  5189, 5197, 5200, 5210, 5218, 5225, 5230, 5237, 5242, 5256, 5272, 5305, 5324,
  5361, 5376, 5411, 5420, 5440, 5448, 5467, 5476, 5495, 5496, 5527, 5552, 5582,
  5592, 5614, 5623, 5663, 5673, 5703, 5713, 5739, 5759, 5801, 5830, 5849, 5885,
  5910, 5932, 5949, 5968, 5994, 6024, 6044, 6059, 6080, 6091, 6099, 6107, 6126,
  6131, 6139, 6147, 6158, 6169, 6177, 6180, 6189, 6194, 6198, 6205, 6208, 6214,
  6217, 6222, 6226, 6231, 6237
] as const

// ------------------ Sajda Data ---------------------
export const SajdaList: AyahId[] = [
  1160,
  1722,
  1951,
  2138,
  2308,
  2613,
  2672,
  2915,
  3185,
  3518,
  3994,
  4256,
  4846,
  5905,
  6125
] as const

export const SurahList: FixedArray<SurahInfo, 116> = [
  [-1, 1, 1, 1, "", false], // this value is not used, but is here to make the array 1-indexed
  [1, 7, 5, 1, "الفَاتِحة", true],
  [8, 286, 87, 40, "البَقَرَة", false],
  [294, 200, 89, 20, "آل عِمران", false],
  [494, 176, 92, 24, "النِّسَاء", false],
  [670, 120, 112, 16, "المَائدة", false],
  [790, 165, 55, 20, "الأنعَام", true],
  [955, 206, 39, 24, "الأعرَاف", true],
  [1161, 75, 88, 10, "الأنفَال", false],
  [1236, 129, 113, 16, "التوبَة", false],
  [1365, 109, 51, 11, "يُونس", true],
  [1474, 123, 52, 10, "هُود", true],
  [1597, 111, 53, 12, "يُوسُف", true],
  [1708, 43, 96, 6, "الرَّعد", false],
  [1751, 52, 72, 7, "إبراهِيم", true],
  [1803, 99, 54, 6, "الحِجر", true],
  [1902, 128, 70, 16, "النَّحل", true],
  [2030, 111, 50, 12, "الإسرَاء", true],
  [2141, 110, 69, 12, "الكَهف", true],
  [2251, 98, 44, 6, "مَريَم", true],
  [2349, 135, 45, 8, "طه", true],
  [2484, 112, 73, 7, "الأنبيَاء", true],
  [2596, 78, 103, 10, "الحج", false],
  [2674, 118, 74, 6, "المؤمنُون", true],
  [2792, 64, 102, 9, "النور", false],
  [2856, 77, 42, 6, "الفُرقَان", true],
  [2933, 227, 47, 11, "الشعراء", true],
  [3160, 93, 48, 7, "النَّمل", true],
  [3253, 88, 49, 8, "القَصَص", true],
  [3341, 69, 85, 7, "العَنكبُوت", true],
  [3410, 60, 84, 6, "الرُّوم", true],
  [3470, 34, 57, 3, "لُقمَان", true],
  [3504, 30, 75, 3, "السَّجدة", true],
  [3534, 73, 90, 9, "الأحزَاب", false],
  [3607, 54, 58, 6, "سَبإ", true],
  [3661, 45, 43, 5, "فَاطِر", true],
  [3706, 83, 41, 5, "يسٓ", true],
  [3789, 182, 56, 5, "الصَّافَات", true],
  [3971, 88, 38, 5, "صٓ", true],
  [4059, 75, 59, 8, "الزُّمَر", true],
  [4134, 85, 60, 9, "غَافِر", true],
  [4219, 54, 61, 6, "فُصِّلَت", true],
  [4273, 53, 62, 5, "الشُّوري", true],
  [4326, 89, 63, 7, "الزُّخرُف", true],
  [4415, 59, 64, 3, "الدُّخان", true],
  [4474, 37, 65, 4, "الجاثِية", true],
  [4511, 35, 66, 4, "الأحقَاف", true],
  [4546, 38, 95, 4, "مُحمد", false],
  [4584, 29, 111, 4, "الفَتح", false],
  [4613, 18, 106, 2, "الحُجُرَات", false],
  [4631, 45, 34, 3, "قٓ", true],
  [4676, 60, 67, 3, "الذَّاريَات", true],
  [4736, 49, 76, 2, "الطُّور", true],
  [4785, 62, 23, 3, "النَّجم", true],
  [4847, 55, 37, 3, "القَمَر", true],
  [4902, 78, 97, 3, "الرَّحمٰن", false],
  [4980, 96, 46, 3, "الوَاقِعة", true],
  [5076, 29, 94, 4, "الحدِيد", false],
  [5105, 22, 105, 3, "المُجَادلة", false],
  [5127, 24, 101, 3, "الحَشر", false],
  [5151, 13, 91, 2, "المُمتَحنَة", false],
  [5164, 14, 109, 2, "الصَّف", false],
  [5178, 11, 110, 2, "الجُمعَة", false],
  [5189, 11, 104, 2, "المُنَافِقُونَ", false],
  [5200, 18, 108, 2, "التغَابُن", false],
  [5218, 12, 99, 2, "الطَّلَاق", false],
  [5230, 12, 107, 2, "التَّحرِيم", false],
  [5242, 30, 77, 2, "المُلك", true],
  [5272, 52, 2, 2, "القَلَم", true],
  [5324, 52, 78, 2, "الحَاقة", true],
  [5376, 44, 79, 2, "المَعَارج", true],
  [5420, 28, 71, 2, "نُوح", true],
  [5448, 28, 40, 2, "الجِن", true],
  [5476, 20, 3, 2, "المُزمل", true],
  [5496, 56, 4, 2, "المُدثر", true],
  [5552, 40, 31, 2, "القِيَامة", true],
  [5592, 31, 98, 2, "الإنسَان", false],
  [5623, 50, 33, 2, "المُرسَلات", true],
  [5673, 40, 80, 2, "النَّبَإ", true],
  [5713, 46, 81, 2, "النَّازعَات", true],
  [5759, 42, 24, 1, "عَبَسَ", true],
  [5801, 29, 7, 1, "التَّكوير", true],
  [5830, 19, 82, 1, "الانفِطَار", true],
  [5849, 36, 86, 1, "المُطَففين", true],
  [5885, 25, 83, 1, "الانشِقَاق", true],
  [5910, 22, 27, 1, "البُرُوج", true],
  [5932, 17, 36, 1, "الطَّارق", true],
  [5949, 19, 8, 1, "الأعلى", true],
  [5968, 26, 68, 1, "الغَاشِية", true],
  [5994, 30, 10, 1, "الفَجر", true],
  [6024, 20, 35, 1, "البَلَد", true],
  [6044, 15, 26, 1, "الشَّمس", true],
  [6059, 21, 9, 1, "اللَّيل", true],
  [6080, 11, 11, 1, "الضُّحى", true],
  [6091, 8, 12, 1, "الشَّرح", true],
  [6099, 8, 28, 1, "التِّين", true],
  [6107, 19, 1, 1, "العَلَق", true],
  [6126, 5, 25, 1, "القَدر", true],
  [6131, 8, 100, 1, "البَينَة", false],
  [6139, 8, 93, 1, "الزَّلزَلة", false],
  [6147, 11, 14, 1, "العَاديَات", true],
  [6158, 11, 30, 1, "القَارعَة", true],
  [6169, 8, 16, 1, "التَّكاثُر", true],
  [6177, 3, 13, 1, "العَصر", true],
  [6180, 9, 32, 1, "الهُمَزة", true],
  [6189, 5, 19, 1, "الفِيل", true],
  [6194, 4, 29, 1, "قُرَيش", true],
  [6198, 7, 17, 1, "المَاعُون", true],
  [6205, 3, 15, 1, "الكَوثر", true],
  [6208, 6, 18, 1, "الكافِرون", true],
  [6214, 3, 114, 1, "النَّصر", false],
  [6217, 5, 6, 1, "المَسَد", true],
  [6222, 4, 22, 1, "الإخلَاص", true],
  [6226, 5, 20, 1, "الفَلَق", true],
  [6231, 6, 21, 1, "النَّاس", true],
  [6237, 1, 1, 1, "", false]
] as const

/**
 * Hafs riwaya metadata
 */
export const HafsMeta: QuranMeta = {
  riwayaName: "Hafs",
  numAyahs: 6236,
  numSurahs: 114,
  numPages: 604,
  numJuzs: 30,
  numHizbs: 60,
  numRubAlHizbs: 240,
  numThumunAlHizbs: 0, // Hafs doesn't have Thumun al-Hizb
  numRubsInJuz: 8,
  numSajdas: 15,
  numRukus: 556,
  numManzils: 7
} as const

export const HafsLists = {
  meta: HafsMeta,
  HizbQuarterList,
  JuzList,
  ManzilList,
  PageList,
  RukuList,
  SajdaList,
  SurahList
}