{"_id":"@alkarartech/quran-english","name":"@alkarartech/quran-english","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@alkarartech/quran-english","version":"1.0.0","description":"The Holy Quran — English translation (Qarai / Shia) in structured JSON for programmatic use","type":"module","main":"dist/quran.cjs","module":"dist/quran.js","types":"dist/quran.d.ts","exports":{".":{"import":"./dist/quran.js","require":"./dist/quran.cjs","types":"./dist/quran.d.ts"},"./data":"./data/quran.json"},"scripts":{"build":"node scripts/parse-quran.cjs && node scripts/build-exports.cjs","prepublishOnly":"npm run build"},"keywords":["quran","koran","islam","translation","english","qarai"],"author":{"name":"Al Karar Tech","url":"https://github.com/alkarartech"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alkarartech/quran-english.git"},"homepage":"https://github.com/alkarartech/quran-english#readme","bugs":{"url":"https://github.com/alkarartech/quran-english/issues"},"_id":"@alkarartech/quran-english@1.0.0","gitHead":"fb2d7dd5050ac3bf8042054b4675537595155cc9","_nodeVersion":"20.19.1","_npmVersion":"11.5.1","dist":{"integrity":"sha512-w4QvW7B26Cy1CvhNPOEJLsxs5D7+O5OmC9y1+dM/emDl2hiBpkEhE1LpnO2p7DWy8jZjMxPjSRuK5QByv6xN2Q==","shasum":"e8b09d3b02c50656c98b5788b886ece4cc76b1a4","tarball":"https://registry.npmjs.org/@alkarartech/quran-english/-/quran-english-1.0.0.tgz","fileCount":7,"unpackedSize":3259848,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIBHq8+lzan5E+9Mps4O0ORcBJXRorLLPlNhZu/j9IAziAiBMVmqtHJZP+ynNsEQ+GC6/Ai7kQnfNNHyIcur6llfveA=="}]},"_npmUser":{"name":"alkarartech","email":"haydar.alkararllc@gmail.com"},"directories":{},"maintainers":[{"name":"alkarartech","email":"haydar.alkararllc@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/quran-english_1.0.0_1773417173901_0.7255836987096784"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-13T15:52:53.801Z","1.0.0":"2026-03-13T15:52:54.144Z","modified":"2026-03-13T15:52:54.358Z"},"maintainers":[{"name":"alkarartech","email":"haydar.alkararllc@gmail.com"}],"description":"The Holy Quran — English translation (Qarai / Shia) in structured JSON for programmatic use","homepage":"https://github.com/alkarartech/quran-english#readme","keywords":["quran","koran","islam","translation","english","qarai"],"repository":{"type":"git","url":"git+https://github.com/alkarartech/quran-english.git"},"author":{"name":"Al Karar Tech","url":"https://github.com/alkarartech"},"bugs":{"url":"https://github.com/alkarartech/quran-english/issues"},"license":"MIT","readme":"# 📖 @alkarartech/quran-english\n\n**The Holy Quran — English translation** in structured JSON for apps, bots, and developers.  \nFull text: **114 surahs**, **6,236 verses**, ready to `import` and use in any JavaScript or TypeScript project.\n\nThis package uses the **Shia** English translation by **Ali Quli Qara'i** (phrase-by-phrase, widely used and respected).\n\n---\n\n## ✨ Features\n\n| Feature | Description |\n|--------|-------------|\n| **Format** | Structured JSON — `surahs` and `verses` with `number` and `text` |\n| **Module support** | ESM and CommonJS; TypeScript types included |\n| **Size** | ~1 MB unpacked; tree-shakeable via JSON import |\n| **Attribution** | Clear credit to the translator and source |\n\n---\n\n## 📥 Install\n\n```bash\nnpm install @alkarartech/quran-english\n```\n\n---\n\n## 🚀 Usage\n\n### ESM (recommended)\n\n```js\nimport quran, { surahs } from '@alkarartech/quran-english';\n\nconsole.log(surahs.length); // 114\n\nconst alFatiha = surahs[0];\nconsole.log(alFatiha.name);           // \"Al-Fatiha\"\nconsole.log(alFatiha.verseCount);     // 7\nconsole.log(alFatiha.verses[0].text); // \"In the Name of Allah, the All-beneficent, the All-merciful.\"\n```\n\n### CommonJS\n\n```js\nconst { surahs } = require('@alkarartech/quran-english');\nconst surah2 = surahs[1];\nconsole.log(surah2.name); // \"Al-Baqara\"\n```\n\n### Raw JSON\n\n```js\nimport data from '@alkarartech/quran-english/data';\n// data.surahs — same structure\n```\n\n### TypeScript\n\n```ts\nimport type { Surah, Verse } from '@alkarartech/quran-english';\nimport { surahs } from '@alkarartech/quran-english';\n\nconst s: Surah = surahs[0];\nconst v: Verse = s.verses[0];\n```\n\n---\n\n## 📐 Data shape\n\n| Level | Shape |\n|-------|--------|\n| **Root** | `{ surahs: Surah[] }` |\n| **Surah** | `{ number, name, verseCount, verses }` |\n| **Verse** | `{ number, text }` |\n\n**Example**\n\n```json\n{\n  \"surahs\": [\n    {\n      \"number\": 1,\n      \"name\": \"Al-Fatiha\",\n      \"verseCount\": 7,\n      \"verses\": [\n        { \"number\": 1, \"text\": \"In the Name of Allah, the All-beneficent, the All-merciful.\" },\n        { \"number\": 2, \"text\": \"All praise belongs to Allah, Lord of all the worlds,\" }\n      ]\n    }\n  ]\n}\n```\n\n---\n\n## 🙏 Translator & translation\n\n### Ali Quli Qara'i\n\nThis package uses the **English translation by Ali Quli Qara'i**. It is a **Shia** translation of the Quran, widely used in English-speaking Shia communities and on platforms such as [Al-Islam.org](https://al-islam.org).\n\n![Ali Quli Qara'i](https://al-islam.org/sites/default/files/persons/ali-quli-qarai.jpg)\n\n**About the translator**\n\n- **Ali Quli Qara'i** graduated from **Osmania University**, Hyderabad, with a B.E. in 1970.\n- He moved to the U.S. and received an **M.B.A.** from the **University of Wisconsin, Madison** (1997).\n- He is a writer and translator and served as **editor-in-chief** of the English quarterly **Al-Tawhid** for **14 years**.\n- He has translated many texts from **Arabic** and **Persian** into English.\n- His major work is the **phrase-by-phrase English translation of the Qur'an**, which is the basis of this package.\n\n**Links**\n\n| Resource | Link |\n|----------|------|\n| **Biography** | [Ali Quli Qara'i — Al-Islam.org](https://al-islam.org/person/ali-quli-qarai) |\n| **Free English PDF** | [Holy Quran — English Translation (PDF)](https://www.duas.org/pdfs/Holy_Quran_Eng_Translation.pdf) |\n\nWe ask that you **respect the translator’s work** and use this package for **personal, educational, and app use** in line with the sources above.\n\n---\n\n## 📜 Source & license\n\n- **Source text:** The translation in this repo is derived from the **Qarai** English translation (Ali Quli Qara'i).\n- **Package:** **MIT** — see [LICENSE](LICENSE).\n- **Translation:** Please follow the terms of the original publishers (e.g. Al-Islam.org, duas.org) when reusing or redistributing the translation text.\n\n---\n\n## 🛠 Scripts\n\n| Command | Description |\n|---------|-------------|\n| `npm run build` | Parses `quran.txt` → `data/quran.json` and builds `dist/` (ESM, CJS, types). Run after editing `quran.txt`. |\n| **prepublishOnly** | Runs `build` automatically before `npm publish`. |\n\n---\n\n## 📦 Repository\n\n- **GitHub:** [github.com/alkarartech/quran-english](https://github.com/alkarartech/quran-english)\n- **Issues:** [github.com/alkarartech/quran-english/issues](https://github.com/alkarartech/quran-english/issues)\n\nThe repo holds the canonical `quran.txt`; the package adds the parsed JSON and built files for easy install and import.\n\n---\n\n## 📌 Publish note (npm scope)\n\nThis package is published under the **@alkarartech** scope so it can be published with a standard npm account. To publish:\n\n```bash\nnpm login\nnpm run build\nnpm publish --access public\n```\n\n`--access public` is required for scoped packages the first time.\n","readmeFilename":"README.md","_rev":"1-9732cd9d660f5181d268d3eead1317aa"}