quran-meta
Version:
Library with meta data and functionality related to Holy Quran
196 lines (136 loc) • 12.2 kB
Markdown
Quran Meta
==========
[](https://github.com/quran-center/quran-meta)
[](https://quran-center.github.io/quran-meta/docs/)
[](https://github.com/quran-center/quran-meta/blob/master/LICENSE)
[](https://github.com/quran-center/quran-meta)
[](https://github.com/quran-center/quran-meta/blob/master/package.json)
[](https://www.npmjs.com/package/quran-meta)
[](https://moiva.io/?npm=quran-meta)
[](https://moiva.io/?npm=quran-meta)
[](https://moiva.io/?npm=quran-meta)
[](https://moiva.io/?npm=quran-meta)
[](https://npm.chart.dev/quran-meta)
[](https://moiva.io/?npm=quran-meta)
[](https://moiva.io/?npm=quran-meta)
[](https://sonarcloud.io/summary/new_code?id=quran-center_quran-meta)
[](https://snyk.io/test/github/quran-center/quran-meta)
[](https://moiva.io/?npm=quran-meta)
[](https://moiva.io/?npm=quran-meta)
[](https://bundlephobia.com/package/quran-meta)
[](https://bundlephobia.com/package/quran-meta)
## Welcome to Quran Meta Project
This project is to help with Quran related meta queries.
Answering Questions like:
* How many ayahs in given surah (`getAyahCountinSurah`)
* Is given ayah
* a sajdah ayah (`getAyahMeta`)?
* beginnning of a page (`isAyahPageFirst`)?
* beginnning of a juz (`isAyahJuzFirst`)?
* Find
* next or previous ayah (`nextAyah`/`prevAyah`)
* juz `findJuz` and `findJuzByAyahId`
* maqra/rub-el-hizb `findRubAlHizb`, `getRubAlHizbMetaByAyahId`
* page `findPage` by surah/ayah
* AyahId of a given surah/ayah (`findAyahIdBySurah`)
* find range around ayah (`findRangeAroundAyah`)
* Get meta data for
* ayah (`getAyahMeta`)
* surah (`getSurahInfo`, `getSurahInfo`)
* page (`getPageMeta`)
* juz (`findJuzMetaBySurah`)
* maqra/rub-el-hizb (`getRubAlHizbMeta`, `getRubAlHizbMetaByAyahId`)
* Validates ayah/surah id (`checkValidAyahId`,`checkValidSurah`, `checkValidSurahAyah`)
* Typescript type guards (`isValidAyahId`, `isValidAyahNo`, `isValidSurah`, `isValidSurahAyah`, `isValidJuz`, `isValidHizb`, `isValidRubAlHizb`, `isValidPage`)
* converts `[surah, ayah]` to `ayahId` and vice-verse ( `findSurahByAyahId` and `findAyahIdBySurah`)
* Checks and turns strings of type "x:y" or "x:y1-y2" to surah/ayah range (`ayaStringSplitter`).
* Checks and parses strings of type "x" to Surah (`surahStringParser`).
### APi Reference Documentation
See [here](https://quran-center.github.io/quran-meta/docs/) for API documentation
### Playground
See in action and try it without installing anything:
* [](https://play.vuejs.org/#eNrdVl9v2zYQ/yqEMMAOYElp3GWY4XhNuwJLAWdZu+1JD6UlWmZMURpJuXEMfYLtdc/7ivsIOx4lhcpSt0Df+mKL9+d3dz8ejzwEl1UV7WoWzIK5ThWvDBFU5hdJYHQSLBLJi6pUhiTBxphKz+I4zWR0qzMm+E5FkplYVkX8opZlqnWsaml4wZKgdzwQxdYTkpZFVRuWkYasVVmQEcQceUYFM3RC1lxmNzRnE5Iz865WdLNEebph6fZ3KniGwss93Thj+3WVvdyj2Ine1Pd9kD9ALEOLDbH6aGZfMQjZ+rh4DmhCwNstrsuJs7AZPA04jx1jwBIsWvY0M3X1iMNEpqXUoLN45MIyMkfsxXh60ikpBG11Lv5ifAbKRApmSAVJgrJjcW6TXozHJ+Ri0ZM2RvhoR0UNBVk4930CKBYD1ViNB9SX2KH5xPuIFsXhWOSrzAdx5Pn5DPblU4ndwo55aLAFPhQsjwE4CKZUqZY693BaiEMiCTFq7z7IU630UXjr0ZCUmnRDxuykg1CwxUoShmr70wqg66HvG3AbdoZhRSWoYbAiZL55tvjFdhHBrbgRdJ+rspbZPAaNszgjs1RQraGD+sJ+ICPD7kyoWDYis3axgixH0GJYCjkc2g5rGhJiE1sR9lXTAPyZgxd0xQTpAqxEmW4JoukiPifrUhpo8IzXhZPmiu7D709PuzCOgzmXwDLZhUUJowBwMHIS4OGCpayLFVOWD2sNtA/CEayYZWGRkVWpMqbCU9glPxzRG5qVHyAporjMw2fuj0s4YO4TLadguS7TWs9QduYvnO1AkPG8DM8tejHra4asY0dNjNx8KU2W+Y+wZDfjqyEJVxnfQX187fUqmHaVdC0LrEAr9s1s2xEcHZ5DYEKzoVuuGJPhd5h7TzbOU6R2M7WQ/VCLJC2Y7fzxQGoJfwU8GquChT6Z9OcEDbhesjSF4wgH7N9//v5zybZbKvGIwfKvJc2o5CN3gKZt0RC9dl2C34Iv7PydWWAc1NYYhL4BnsarDG3aAfqEFcw6tLATcaCex33AOS9yMtMqBZ7e+5cyFXg7Rako6yy2dNGYF5BP/M0B623gw8Zu3reb6bbTbUQ7eRa/abauBfFG1I/U0HZ6tGYPuUCC19jEpFyTJZX3XGiswF6REfR3K3tUzcANp8rQy4mOOVk+hz4oOeZi92jogpJjLrAfQw8rOObwE79fDT1Qcszlbb0il8J5Qtd5rqC5FJ/hv63/52hFnk/bPvPYu4qCSeDeQ2FBK3jRlRLegHjDJa0CHi8A62ImwcPTx4o/8R58MH7xbXQaPQ/Poc20iWG4sLuouAXo9vZsIA+j4Qm05vmjLOxNzgVTP1eGwxNpkA0VovzwBmVGwbXdyfF6f0J+q+9c2jeKaaZ28ETtdYYqePU49et31zB7PCVM7lqA9RHlW6ZLUdscndlLGNuQtmeH2V4hqTBif9Wv7wyTuivKJopsoH0SwNP41ZHSH9KdRs97Fpv/ACCr+80=) - interactive playground for Quran-Meta
### Installation
#### In a browser:
```html
<script src="quran-meta.js"></script>
```
Also modern browsers allow
```html
<script type="module">
import quranMeta from "quran-meta.esm.js"
</script>
```
The library is available from various CDNs
* [JSDelivr](https://cdn.jsdelivr.net/npm/quran-meta/dist/)
* [UnPKG](https://unpkg.com/browse/quran-meta/dist/)
#### Using npm:
```
$ npm i --save quran-meta
```
### Usage
In Node.js see example [here](/examples/hello.cjs):
```js
var quranMeta = require("quran-meta")
console.log(" Assalam Aleykum! ") // => 'Assalam Aleykum!'
console.log(`There are ${quranMeta.meta.numSurahs} suras in the Holy Quran`) // => 'There are 114 suras in the Holy Quran'
```
In the browser/ES:
```js
import { meta } from "quran-meta"
console.log("Assalam Aleykum!")
console.log(`There are ${meta.numSurahs} suras in the Holy Quran`) // => 'There are 114 suras in the Holy Quran'
```
In TypeScript:
```ts
import { meta, getAyahCountinSurah, AyahNo, Surah } from "quran-meta"
console.log(`There are ${meta.numSurahs} suras in the Holy Quran`)
for (let surah: Surah = 1; surah <= meta.numSurahs; surah++) {
const ayaCount = getAyahCountinSurah(surah)
console.log(surah, ': ',ayaCount)
}
```
### Terminology
* Surah: A chapter of the Quran. There are 114 chapters in Quran, each of different length.
* Ayah: A verse number in the particular surah (chapter) of Quran. it is relative to the surah.
* AyahId: Unique identifier for a verse in the Quran. It is a number that is the concatenation of the of sum ayahs of previous chapters of Quran and the verse number of particular Ayah. There are 6236 ayahs in Quran. AyahId is absolute, positive and is not relative to any surah.
* *Juz*: A section of the Quran. There are 30 Juz (ajza) in Quran of roughly equal length. Most Juz' are named after the first word of the first verse of the Juz'. Read more [here](https://en.wikipedia.org/wiki/Juz%27)
* *Hizb*: Each Juz' is divided into two Hizb (lit. "two groups", plural: Aḥzāb). Therefore, there are 60 Hizbs (ahzab) in the Quran.
* *Rub-el-Hizb/Maqra*: Each Hizb is subdivided into four quarters called Maqra (lit. "reading"), making eight quarters per Juz. In Arabic, `rub` means 'one-fourth' or 'quarter', while `ḥizb` (plural aḥzāb) translates to 'a group'. There are 240 Maqras in the Quran. In most mushafs it is noted by symbol in the shape of an octagram, represented as two overlapping squares **۞**. Read more [here](https://en.wikipedia.org/wiki/Rub_el_Hizb)
* *Manzil*: For the convenience of those who read the Quran in a week the text may be divided into seven portions. Each portion is called a Manzil. There are 7 Manzil in Quran. Read more [here](https://en.wikipedia.org/wiki/Manzil)
* *Page*: A section of the Quran that contains 15 lines (Madina mushaf)(depends on the mushaf).
* *Saajdah*: Special ayahs that require reader to prostrate. There are 15 of them in Quran.
* *Ruku*: (paragraph) is a group of related verses in a Surah. The end of a Ruku’ is marked by the Arabic letter **ﻉ** in superscript. There are 558 Rukus in the Quran. These are logical sections according to similar theme/objective or meaning. The bigger Surahs have been split into a number of Rukus, so that we would recognize when to do Ruku' (bowing) in Salat without interrupting a proceeding subject of the Quran. Additionally, on the margins of the Quran, usually three figures are written with **ﻉ**. The top figure shows the number of Rukus completed in that Surah. The middle figure shows the number of Ayats in the Ruku just completed. The bottom figure shows the number of Rukus completed in that Juz.
### Examples
You can find some examples [here](https://quran-center.github.io/quran-meta/examples/) and souce code for them [here](https://github.com/quran-center/quran-meta/tree/master/examples)
### Projects using Quran-meta
* [Koran-Center](https://koran.center) - Powerful and feature rich web application for reading and studying the Holy Quran.
### Demo
* [Quran Meta Visualiser ESM Alpine3](https://codesandbox.io/p/sandbox/quran-visualiser-esm-alpine-3-q89frt) - demo app showcasing number of methods from Quran-meta to build interactive visualisations of Quran structure using Alpine.js 3 & Chart.js 4 in ESM format.
* [Quran Meta Visualiser ES module version](https://codesandbox.io/s/quran-visualiser-es-module-f0sq0) - Alpine.js 2& ChartJs.2 version of the previous demo
* [Quran Meta Visualiser CJS](https://codesandbox.io/s/quran-visualiser-p3zjd) - CommonJS version of the previous demo
### Data correctness and validity testing
Quran-Meta is 100% unit test covered and moreover data is cross checked with other apis to guarantee absolute correctness.
One can run `pnpx jiti examples/data-check` to run suite of validation tests against the following data sources
* `qcloud-meta.json` - [AlQuran Cloud Api metadata](https://api.alquran.cloud/v1/meta)
* `tanzil-data.js` - [Tanzil.net metadata](https://tanzil.net/res/text/metadata/quran-data.js)
* `quran-api.json` - [Quran Api metadata](https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api/info.json)
* `hafsData_v2-0.json` - [Data coming with UthmanicHafs font from KFQC](https://download.qurancomplex.gov.sa/resources_dev/UthmanicHafs_v2-0.zip)
* `hafs_smart_v8.json` - [Data coming with Smart device UthmanicHafs font from KFQC](https://download.qurancomplex.gov.sa/resources_dev/UthmanicHafs_v2-0.zip)
Any suggestion to further improve this are welcome.
### Distributions and Downloads
Here you can find the following
|||
|--|--|
|[Source code](https://github.com/quran-center/quran-meta/tree/master/src) in typescript | TS |
|||
**[Distributions](https://cdn.jsdelivr.net/npm/quran-meta/dist/) of library as**| |
| [ESM](https://cdn.jsdelivr.net/npm/quran-meta/dist/index.mjs) for use with modern bundlers like webpack 2 or Rollup and for direct imports in modern browsers via `<script type="module">`| ES5+ESM |
### References:
* [Tanzil.net](https://tanzil.net)
* [Quran.com Js Api](https://github.com/quran/api-js), [Quran.com API](https://api-docs.quran.com/),
* [AlQuran Cloud](https://alquran.cloud/api)
* [KFGC Data](https://qurancomplex.gov.sa/en/techquran/dev/)
### License
This software is distributed under MIT license.