@quranjs/api 1.0.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 (88) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +21 -0
  3. package/dist/api.cjs.development.js +2627 -0
  4. package/dist/api.cjs.development.js.map +1 -0
  5. package/dist/api.cjs.production.min.js +2 -0
  6. package/dist/api.cjs.production.min.js.map +1 -0
  7. package/dist/api.esm.js +2618 -0
  8. package/dist/api.esm.js.map +1 -0
  9. package/dist/index.d.ts +2 -0
  10. package/dist/index.js +8 -0
  11. package/dist/sdk/index.d.ts +183 -0
  12. package/dist/sdk/utils.d.ts +125 -0
  13. package/dist/sdk/v4/_fetcher.d.ts +3 -0
  14. package/dist/sdk/v4/audio.d.ts +52 -0
  15. package/dist/sdk/v4/chapters.d.ts +13 -0
  16. package/dist/sdk/v4/index.d.ts +173 -0
  17. package/dist/sdk/v4/juzs.d.ts +5 -0
  18. package/dist/sdk/v4/resources.d.ts +26 -0
  19. package/dist/sdk/v4/search.d.ts +22 -0
  20. package/dist/sdk/v4/verses.d.ts +64 -0
  21. package/dist/types/ChapterId.d.ts +1 -0
  22. package/dist/types/HizbNumber.d.ts +1 -0
  23. package/dist/types/JuzNumber.d.ts +1 -0
  24. package/dist/types/PageNumber.d.ts +1 -0
  25. package/dist/types/RubNumber.d.ts +1 -0
  26. package/dist/types/VerseKey.d.ts +1 -0
  27. package/dist/types/api/ApiResponses.d.ts +18 -0
  28. package/dist/types/api/AudioData.d.ts +17 -0
  29. package/dist/types/api/AudioResponse.d.ts +8 -0
  30. package/dist/types/api/Chapter.d.ts +14 -0
  31. package/dist/types/api/ChapterInfo.d.ts +8 -0
  32. package/dist/types/api/Footnote.d.ts +6 -0
  33. package/dist/types/api/Juz.d.ts +8 -0
  34. package/dist/types/api/Pagination.d.ts +7 -0
  35. package/dist/types/api/Reciter.d.ts +21 -0
  36. package/dist/types/api/Resources.d.ts +70 -0
  37. package/dist/types/api/Segment.d.ts +4 -0
  38. package/dist/types/api/Tafsir.d.ts +7 -0
  39. package/dist/types/api/TafsirInfo.d.ts +9 -0
  40. package/dist/types/api/TranslatedName.d.ts +4 -0
  41. package/dist/types/api/Translation.d.ts +17 -0
  42. package/dist/types/api/Transliteration.d.ts +4 -0
  43. package/dist/types/api/Verse.d.ts +32 -0
  44. package/dist/types/api/Word.d.ts +28 -0
  45. package/dist/types/api/index.d.ts +18 -0
  46. package/dist/types/index.d.ts +88 -0
  47. package/dist/utils/misc.d.ts +1 -0
  48. package/dist/utils/qs-stringify.d.ts +21 -0
  49. package/package.json +64 -0
  50. package/src/index.ts +2 -0
  51. package/src/sdk/index.ts +9 -0
  52. package/src/sdk/utils.ts +230 -0
  53. package/src/sdk/v4/_fetcher.ts +28 -0
  54. package/src/sdk/v4/audio.ts +266 -0
  55. package/src/sdk/v4/chapters.ts +83 -0
  56. package/src/sdk/v4/index.ts +17 -0
  57. package/src/sdk/v4/juzs.ts +17 -0
  58. package/src/sdk/v4/resources.ts +224 -0
  59. package/src/sdk/v4/search.ts +40 -0
  60. package/src/sdk/v4/verses.ts +213 -0
  61. package/src/types/ChapterId.ts +115 -0
  62. package/src/types/HizbNumber.ts +61 -0
  63. package/src/types/JuzNumber.ts +31 -0
  64. package/src/types/PageNumber.ts +519 -0
  65. package/src/types/RubNumber.ts +241 -0
  66. package/src/types/VerseKey.ts +6237 -0
  67. package/src/types/api/ApiResponses.ts +19 -0
  68. package/src/types/api/AudioData.ts +20 -0
  69. package/src/types/api/AudioResponse.ts +9 -0
  70. package/src/types/api/Chapter.ts +15 -0
  71. package/src/types/api/ChapterInfo.ts +8 -0
  72. package/src/types/api/Footnote.ts +6 -0
  73. package/src/types/api/Juz.ts +8 -0
  74. package/src/types/api/Pagination.ts +7 -0
  75. package/src/types/api/Reciter.ts +21 -0
  76. package/src/types/api/Resources.ts +81 -0
  77. package/src/types/api/Segment.ts +4 -0
  78. package/src/types/api/Tafsir.ts +7 -0
  79. package/src/types/api/TafsirInfo.ts +10 -0
  80. package/src/types/api/TranslatedName.ts +4 -0
  81. package/src/types/api/Translation.ts +21 -0
  82. package/src/types/api/Transliteration.ts +4 -0
  83. package/src/types/api/Verse.ts +35 -0
  84. package/src/types/api/Word.ts +30 -0
  85. package/src/types/api/index.ts +18 -0
  86. package/src/types/index.ts +134 -0
  87. package/src/utils/misc.ts +3 -0
  88. package/src/utils/qs-stringify.ts +81 -0
package/src/types/PageNumber.ts ADDED
@@ -0,0 +1,519 @@
1
+ // there are 604 pages
2
+ export type PageNumber =
3
+ | '1'
4
+ | '2'
5
+ | '3'
6
+ | '4'
7
+ | '5'
8
+ | '6'
9
+ | '7'
10
+ | '8'
11
+ | '9'
12
+ | '10'
13
+ | '11'
14
+ | '12'
15
+ | '13'
16
+ | '14'
17
+ | '15'
18
+ | '16'
19
+ | '17'
20
+ | '18'
21
+ | '19'
22
+ | '20'
23
+ | '21'
24
+ | '22'
25
+ | '23'
26
+ | '24'
27
+ | '25'
28
+ | '26'
29
+ | '27'
30
+ | '28'
31
+ | '29'
32
+ | '30'
33
+ | '31'
34
+ | '32'
35
+ | '33'
36
+ | '34'
37
+ | '35'
38
+ | '36'
39
+ | '37'
40
+ | '38'
41
+ | '39'
42
+ | '40'
43
+ | '41'
44
+ | '42'
45
+ | '43'
46
+ | '44'
47
+ | '45'
48
+ | '46'
49
+ | '47'
50
+ | '48'
51
+ | '49'
52
+ | '50'
53
+ | '51'
54
+ | '52'
55
+ | '53'
56
+ | '54'
57
+ | '55'
58
+ | '56'
59
+ | '57'
60
+ | '58'
61
+ | '59'
62
+ | '60'
63
+ | '61'
64
+ | '62'
65
+ | '63'
66
+ | '64'
67
+ | '65'
68
+ | '66'
69
+ | '67'
70
+ | '68'
71
+ | '69'
72
+ | '70'
73
+ | '71'
74
+ | '72'
75
+ | '73'
76
+ | '74'
77
+ | '75'
78
+ | '76'
79
+ | '77'
80
+ | '78'
81
+ | '79'
82
+ | '80'
83
+ | '81'
84
+ | '82'
85
+ | '83'
86
+ | '84'
87
+ | '85'
88
+ | '86'
89
+ | '87'
90
+ | '88'
91
+ | '89'
92
+ | '90'
93
+ | '91'
94
+ | '92'
95
+ | '93'
96
+ | '94'
97
+ | '95'
98
+ | '96'
99
+ | '97'
100
+ | '98'
101
+ | '99'
102
+ | '100'
103
+ | '101'
104
+ | '102'
105
+ | '103'
106
+ | '104'
107
+ | '105'
108
+ | '106'
109
+ | '107'
110
+ | '108'
111
+ | '109'
112
+ | '110'
113
+ | '111'
114
+ | '112'
115
+ | '113'
116
+ | '114'
117
+ | '115'
118
+ | '116'
119
+ | '117'
120
+ | '118'
121
+ | '119'
122
+ | '120'
123
+ | '121'
124
+ | '122'
125
+ | '123'
126
+ | '124'
127
+ | '125'
128
+ | '126'
129
+ | '127'
130
+ | '128'
131
+ | '129'
132
+ | '130'
133
+ | '131'
134
+ | '132'
135
+ | '133'
136
+ | '134'
137
+ | '135'
138
+ | '136'
139
+ | '137'
140
+ | '138'
141
+ | '139'
142
+ | '140'
143
+ | '141'
144
+ | '142'
145
+ | '143'
146
+ | '144'
147
+ | '145'
148
+ | '146'
149
+ | '147'
150
+ | '148'
151
+ | '149'
152
+ | '150'
153
+ | '151'
154
+ | '152'
155
+ | '153'
156
+ | '154'
157
+ | '155'
158
+ | '156'
159
+ | '157'
160
+ | '158'
161
+ | '159'
162
+ | '160'
163
+ | '161'
164
+ | '162'
165
+ | '163'
166
+ | '164'
167
+ | '165'
168
+ | '166'
169
+ | '167'
170
+ | '168'
171
+ | '169'
172
+ | '170'
173
+ | '171'
174
+ | '172'
175
+ | '173'
176
+ | '174'
177
+ | '175'
178
+ | '176'
179
+ | '177'
180
+ | '178'
181
+ | '179'
182
+ | '180'
183
+ | '181'
184
+ | '182'
185
+ | '183'
186
+ | '184'
187
+ | '185'
188
+ | '186'
189
+ | '187'
190
+ | '188'
191
+ | '189'
192
+ | '190'
193
+ | '191'
194
+ | '192'
195
+ | '193'
196
+ | '194'
197
+ | '195'
198
+ | '196'
199
+ | '197'
200
+ | '198'
201
+ | '199'
202
+ | '200'
203
+ | '201'
204
+ | '202'
205
+ | '203'
206
+ | '204'
207
+ | '205'
208
+ | '206'
209
+ | '207'
210
+ | '208'
211
+ | '209'
212
+ | '210'
213
+ | '211'
214
+ | '212'
215
+ | '213'
216
+ | '214'
217
+ | '215'
218
+ | '216'
219
+ | '217'
220
+ | '218'
221
+ | '219'
222
+ | '220'
223
+ | '221'
224
+ | '222'
225
+ | '223'
226
+ | '224'
227
+ | '225'
228
+ | '226'
229
+ | '227'
230
+ | '228'
231
+ | '229'
232
+ | '230'
233
+ | '231'
234
+ | '232'
235
+ | '233'
236
+ | '234'
237
+ | '235'
238
+ | '236'
239
+ | '237'
240
+ | '238'
241
+ | '239'
242
+ | '240'
243
+ | '241'
244
+ | '242'
245
+ | '243'
246
+ | '244'
247
+ | '245'
248
+ | '246'
249
+ | '247'
250
+ | '248'
251
+ | '249'
252
+ | '250'
253
+ | '251'
254
+ | '252'
255
+ | '253'
256
+ | '254'
257
+ | '255'
258
+ | '256'
259
+ | '257'
260
+ | '258'
261
+ | '259'
262
+ | '260'
263
+ | '261'
264
+ | '262'
265
+ | '263'
266
+ | '264'
267
+ | '265'
268
+ | '266'
269
+ | '267'
270
+ | '268'
271
+ | '269'
272
+ | '270'
273
+ | '271'
274
+ | '272'
275
+ | '273'
276
+ | '274'
277
+ | '275'
278
+ | '276'
279
+ | '277'
280
+ | '278'
281
+ | '279'
282
+ | '280'
283
+ | '281'
284
+ | '282'
285
+ | '283'
286
+ | '284'
287
+ | '285'
288
+ | '286'
289
+ | '287'
290
+ | '288'
291
+ | '289'
292
+ | '290'
293
+ | '291'
294
+ | '292'
295
+ | '293'
296
+ | '294'
297
+ | '295'
298
+ | '296'
299
+ | '297'
300
+ | '298'
301
+ | '299'
302
+ | '300'
303
+ | '301'
304
+ | '302'
305
+ | '303'
306
+ | '304'
307
+ | '305'
308
+ | '306'
309
+ | '307'
310
+ | '308'
311
+ | '309'
312
+ | '310'
313
+ | '311'
314
+ | '312'
315
+ | '313'
316
+ | '314'
317
+ | '315'
318
+ | '316'
319
+ | '317'
320
+ | '318'
321
+ | '319'
322
+ | '320'
323
+ | '321'
324
+ | '322'
325
+ | '323'
326
+ | '324'
327
+ | '325'
328
+ | '326'
329
+ | '327'
330
+ | '328'
331
+ | '329'
332
+ | '330'
333
+ | '331'
334
+ | '332'
335
+ | '333'
336
+ | '334'
337
+ | '335'
338
+ | '336'
339
+ | '337'
340
+ | '338'
341
+ | '339'
342
+ | '340'
343
+ | '341'
344
+ | '342'
345
+ | '343'
346
+ | '344'
347
+ | '345'
348
+ | '346'
349
+ | '347'
350
+ | '348'
351
+ | '349'
352
+ | '350'
353
+ | '351'
354
+ | '352'
355
+ | '353'
356
+ | '354'
357
+ | '355'
358
+ | '356'
359
+ | '357'
360
+ | '358'
361
+ | '359'
362
+ | '360'
363
+ | '361'
364
+ | '362'
365
+ | '363'
366
+ | '364'
367
+ | '365'
368
+ | '366'
369
+ | '367'
370
+ | '368'
371
+ | '369'
372
+ | '370'
373
+ | '371'
374
+ | '372'
375
+ | '373'
376
+ | '374'
377
+ | '375'
378
+ | '376'
379
+ | '377'
380
+ | '378'
381
+ | '379'
382
+ | '380'
383
+ | '381'
384
+ | '382'
385
+ | '383'
386
+ | '384'
387
+ | '385'
388
+ | '386'
389
+ | '387'
390
+ | '388'
391
+ | '389'
392
+ | '390'
393
+ | '391'
394
+ | '392'
395
+ | '393'
396
+ | '394'
397
+ | '395'
398
+ | '396'
399
+ | '397'
400
+ | '398'
401
+ | '399'
402
+ | '400'
403
+ | '401'
404
+ | '402'
405
+ | '403'
406
+ | '404'
407
+ | '405'
408
+ | '406'
409
+ | '407'
410
+ | '408'
411
+ | '409'
412
+ | '410'
413
+ | '411'
414
+ | '412'
415
+ | '413'
416
+ | '414'
417
+ | '415'
418
+ | '416'
419
+ | '417'
420
+ | '418'
421
+ | '419'
422
+ | '420'
423
+ | '421'
424
+ | '422'
425
+ | '423'
426
+ | '424'
427
+ | '425'
428
+ | '426'
429
+ | '427'
430
+ | '428'
431
+ | '429'
432
+ | '430'
433
+ | '431'
434
+ | '432'
435
+ | '433'
436
+ | '434'
437
+ | '435'
438
+ | '436'
439
+ | '437'
440
+ | '438'
441
+ | '439'
442
+ | '440'
443
+ | '441'
444
+ | '442'
445
+ | '443'
446
+ | '444'
447
+ | '445'
448
+ | '446'
449
+ | '447'
450
+ | '448'
451
+ | '449'
452
+ | '450'
453
+ | '451'
454
+ | '452'
455
+ | '453'
456
+ | '454'
457
+ | '455'
458
+ | '456'
459
+ | '457'
460
+ | '458'
461
+ | '459'
462
+ | '460'
463
+ | '461'
464
+ | '462'
465
+ | '463'
466
+ | '464'
467
+ | '465'
468
+ | '466'
469
+ | '467'
470
+ | '468'
471
+ | '469'
472
+ | '470'
473
+ | '471'
474
+ | '472'
475
+ | '473'
476
+ | '474'
477
+ | '475'
478
+ | '476'
479
+ | '477'
480
+ | '478'
481
+ | '479'
482
+ | '480'
483
+ | '481'
484
+ | '482'
485
+ | '483'
486
+ | '484'
487
+ | '485'
488
+ | '486'
489
+ | '487'
490
+ | '488'
491
+ | '489'
492
+ | '490'
493
+ | '491'
494
+ | '492'
495
+ | '493'
496
+ | '494'
497
+ | '495'
498
+ | '496'
499
+ | '497'
500
+ | '498'
501
+ | '499'
502
+ | '500'
503
+ | '501'
504
+ | '502'
505
+ | '503'
506
+ | '504'
507
+ | '505'
508
+ | '506'
509
+ | '507'
510
+ | '508'
511
+ | '509'
512
+ | '510'
513
+ | '511'
514
+ | '512'
515
+ | '513'
516
+ | '514'
517
+ | '515'
518
+ | '516'
519
+ | '517';