@quranjs/api 1.0.1 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/README.md +19 -6
  2. package/package.json +5 -6
  3. package/dist/api.cjs.development.js +0 -2627
  4. package/dist/api.cjs.development.js.map +0 -1
  5. package/dist/api.cjs.production.min.js +0 -2
  6. package/dist/api.cjs.production.min.js.map +0 -1
  7. package/dist/api.esm.js +0 -2618
  8. package/dist/api.esm.js.map +0 -1
  9. package/dist/index.d.ts +0 -2
  10. package/dist/index.js +0 -8
  11. package/dist/sdk/index.d.ts +0 -183
  12. package/dist/sdk/utils.d.ts +0 -125
  13. package/dist/sdk/v4/_fetcher.d.ts +0 -3
  14. package/dist/sdk/v4/audio.d.ts +0 -52
  15. package/dist/sdk/v4/chapters.d.ts +0 -13
  16. package/dist/sdk/v4/index.d.ts +0 -173
  17. package/dist/sdk/v4/juzs.d.ts +0 -5
  18. package/dist/sdk/v4/resources.d.ts +0 -26
  19. package/dist/sdk/v4/search.d.ts +0 -22
  20. package/dist/sdk/v4/verses.d.ts +0 -64
  21. package/dist/types/ChapterId.d.ts +0 -1
  22. package/dist/types/HizbNumber.d.ts +0 -1
  23. package/dist/types/JuzNumber.d.ts +0 -1
  24. package/dist/types/PageNumber.d.ts +0 -1
  25. package/dist/types/RubNumber.d.ts +0 -1
  26. package/dist/types/VerseKey.d.ts +0 -1
  27. package/dist/types/api/ApiResponses.d.ts +0 -18
  28. package/dist/types/api/AudioData.d.ts +0 -17
  29. package/dist/types/api/AudioResponse.d.ts +0 -8
  30. package/dist/types/api/Chapter.d.ts +0 -14
  31. package/dist/types/api/ChapterInfo.d.ts +0 -8
  32. package/dist/types/api/Footnote.d.ts +0 -6
  33. package/dist/types/api/Juz.d.ts +0 -8
  34. package/dist/types/api/Pagination.d.ts +0 -7
  35. package/dist/types/api/Reciter.d.ts +0 -21
  36. package/dist/types/api/Resources.d.ts +0 -70
  37. package/dist/types/api/Segment.d.ts +0 -4
  38. package/dist/types/api/Tafsir.d.ts +0 -7
  39. package/dist/types/api/TafsirInfo.d.ts +0 -9
  40. package/dist/types/api/TranslatedName.d.ts +0 -4
  41. package/dist/types/api/Translation.d.ts +0 -17
  42. package/dist/types/api/Transliteration.d.ts +0 -4
  43. package/dist/types/api/Verse.d.ts +0 -32
  44. package/dist/types/api/Word.d.ts +0 -28
  45. package/dist/types/api/index.d.ts +0 -18
  46. package/dist/types/index.d.ts +0 -88
  47. package/dist/utils/misc.d.ts +0 -1
  48. package/dist/utils/qs-stringify.d.ts +0 -21
package/README.md CHANGED
@@ -1,10 +1,11 @@
1
- <p align="center">
2
- <img src="https://avatars.githubusercontent.com/u/102173125?s=200&v=4" />
3
- </p>
1
+ ![Quranjs Api Header](/media/repo-header.png)
2
+ A library for fetching quran data from the [quran.com API][qdc-api]. This library also works on both Node.js and the browser.
4
3
 
5
- # @quranjs/api
6
-
7
- A library for fetching quran data from the quran.com API. It is a wrapper around the [quran.com API](https://quran.api-docs.io/). This library also works in both Node.js and the browser.
4
+ [![Build Status][build-badge]][build]
5
+ [![MIT License][license-badge]][license]
6
+ [![NPM Version][npm-badge]][npm]
7
+ [![NPM Monthly downloads][downloads-badge]][npm]
8
+ [![Minziped Size][size-badge]][npm]
8
9
 
9
10
  ## Installation
10
11
 
@@ -19,3 +20,15 @@ using yarn:
19
20
  ```ssh
20
21
  yarn add @quranjs/api
21
22
  ```
23
+
24
+ <!-- Links -->
25
+
26
+ [qdc-api]: https://quran.api-docs.io/
27
+ [build-badge]: https://img.shields.io/github/workflow/status/quranjs/api/CI?logo=github&style=flat-square
28
+ [build]: https://github.com/quranjs/api/actions?query=workflow%3ACI
29
+ [license-badge]: https://img.shields.io/github/license/quranjs/api?style=flat-square
30
+ [license]: https://github.com/quranjs/api/blob/master/LICENSE
31
+ [npm]: https://www.npmjs.com/package/@quranjs/api
32
+ [npm-badge]: https://img.shields.io/npm/v/@quranjs/api.svg?style=flat-square
33
+ [downloads-badge]: https://img.shields.io/npm/dm/@quranjs/api.svg?style=flat-square
34
+ [size-badge]: https://img.shields.io/bundlephobia/minzip/@quranjs/api/latest.svg?style=flat-square
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "publishConfig": {
6
6
  "access": "public"
7
7
  },
8
- "version": "1.0.1",
8
+ "version": "1.1.1",
9
9
  "license": "MIT",
10
10
  "main": "dist/index.js",
11
11
  "typings": "dist/index.d.ts",
@@ -20,7 +20,7 @@
20
20
  "test": "dts test",
21
21
  "test:dev": "dts test --watch",
22
22
  "lint": "dts lint src test mocks",
23
- "prepare": "husky install && dts build",
23
+ "prepare": "husky install",
24
24
  "size": "size-limit",
25
25
  "analyze": "size-limit --why"
26
26
  },
@@ -32,8 +32,7 @@
32
32
  "dts-cli": "^1.4.0",
33
33
  "husky": "^7.0.4",
34
34
  "msw": "^0.39.2",
35
- "rollup-plugin-buble": "^0.19.8",
36
- "rollup-plugin-sizes": "^1.0.4",
35
+ "rollup-plugin-analyzer": "^4.0.0",
37
36
  "size-limit": "^7.0.8",
38
37
  "tslib": "^2.3.1",
39
38
  "typescript": "^4.6.2"
@@ -47,11 +46,11 @@
47
46
  "size-limit": [
48
47
  {
49
48
  "path": "dist/api.cjs.production.min.js",
50
- "limit": "10 KB"
49
+ "limit": "15 KB"
51
50
  },
52
51
  {
53
52
  "path": "dist/api.esm.js",
54
- "limit": "10 KB"
53
+ "limit": "15 KB"
55
54
  }
56
55
  ],
57
56
  "engines": {