@quranjs/api 1.5.1 → 1.7.0

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 (63) hide show
  1. package/dist/index.d.ts +553 -2
  2. package/dist/index.js +11 -6
  3. package/dist/index.js.map +1 -0
  4. package/dist/index.mjs +6 -0
  5. package/dist/index.mjs.map +1 -0
  6. package/package.json +25 -21
  7. package/src/sdk/utils.ts +18 -9
  8. package/src/sdk/v4/_fetcher.ts +58 -7
  9. package/src/sdk/v4/audio.ts +30 -50
  10. package/src/sdk/v4/chapters.ts +12 -15
  11. package/src/sdk/v4/juzs.ts +7 -2
  12. package/src/sdk/v4/resources.ts +27 -31
  13. package/src/sdk/v4/search.ts +14 -13
  14. package/src/sdk/v4/verses.ts +79 -58
  15. package/src/types/BaseApiOptions.ts +6 -0
  16. package/src/types/FetchFn.ts +1 -0
  17. package/src/types/index.ts +2 -0
  18. package/dist/api.cjs.development.js +0 -2723
  19. package/dist/api.cjs.development.js.map +0 -1
  20. package/dist/api.cjs.production.min.js +0 -2
  21. package/dist/api.cjs.production.min.js.map +0 -1
  22. package/dist/api.esm.js +0 -2715
  23. package/dist/api.esm.js.map +0 -1
  24. package/dist/sdk/index.d.ts +0 -183
  25. package/dist/sdk/utils.d.ts +0 -125
  26. package/dist/sdk/v4/_fetcher.d.ts +0 -3
  27. package/dist/sdk/v4/audio.d.ts +0 -52
  28. package/dist/sdk/v4/chapters.d.ts +0 -13
  29. package/dist/sdk/v4/index.d.ts +0 -173
  30. package/dist/sdk/v4/juzs.d.ts +0 -5
  31. package/dist/sdk/v4/resources.d.ts +0 -26
  32. package/dist/sdk/v4/search.d.ts +0 -22
  33. package/dist/sdk/v4/verses.d.ts +0 -64
  34. package/dist/types/ChapterId.d.ts +0 -4
  35. package/dist/types/HizbNumber.d.ts +0 -4
  36. package/dist/types/JuzNumber.d.ts +0 -4
  37. package/dist/types/PageNumber.d.ts +0 -4
  38. package/dist/types/RubNumber.d.ts +0 -4
  39. package/dist/types/VerseKey.d.ts +0 -2
  40. package/dist/types/api/ApiResponses.d.ts +0 -18
  41. package/dist/types/api/AudioData.d.ts +0 -17
  42. package/dist/types/api/AudioResponse.d.ts +0 -8
  43. package/dist/types/api/Chapter.d.ts +0 -14
  44. package/dist/types/api/ChapterInfo.d.ts +0 -8
  45. package/dist/types/api/Footnote.d.ts +0 -6
  46. package/dist/types/api/Juz.d.ts +0 -8
  47. package/dist/types/api/Pagination.d.ts +0 -7
  48. package/dist/types/api/Reciter.d.ts +0 -21
  49. package/dist/types/api/Resources.d.ts +0 -70
  50. package/dist/types/api/Segment.d.ts +0 -4
  51. package/dist/types/api/Tafsir.d.ts +0 -7
  52. package/dist/types/api/TafsirInfo.d.ts +0 -9
  53. package/dist/types/api/TranslatedName.d.ts +0 -4
  54. package/dist/types/api/Translation.d.ts +0 -17
  55. package/dist/types/api/Transliteration.d.ts +0 -4
  56. package/dist/types/api/Verse.d.ts +0 -32
  57. package/dist/types/api/Word.d.ts +0 -28
  58. package/dist/types/api/index.d.ts +0 -18
  59. package/dist/types/index.d.ts +0 -88
  60. package/dist/types/utils.d.ts +0 -5
  61. package/dist/utils/misc.d.ts +0 -1
  62. package/dist/utils/qs-stringify.d.ts +0 -21
  63. package/src/utils/qs-stringify.ts +0 -81
@@ -1,125 +0,0 @@
1
- export declare const versesMapping: {
2
- '1': number;
3
- '2': number;
4
- '3': number;
5
- '4': number;
6
- '5': number;
7
- '6': number;
8
- '7': number;
9
- '8': number;
10
- '9': number;
11
- '10': number;
12
- '11': number;
13
- '12': number;
14
- '13': number;
15
- '14': number;
16
- '15': number;
17
- '16': number;
18
- '17': number;
19
- '18': number;
20
- '19': number;
21
- '20': number;
22
- '21': number;
23
- '22': number;
24
- '23': number;
25
- '24': number;
26
- '25': number;
27
- '26': number;
28
- '27': number;
29
- '28': number;
30
- '29': number;
31
- '30': number;
32
- '31': number;
33
- '32': number;
34
- '33': number;
35
- '34': number;
36
- '35': number;
37
- '36': number;
38
- '37': number;
39
- '38': number;
40
- '39': number;
41
- '40': number;
42
- '41': number;
43
- '42': number;
44
- '43': number;
45
- '44': number;
46
- '45': number;
47
- '46': number;
48
- '47': number;
49
- '48': number;
50
- '49': number;
51
- '50': number;
52
- '51': number;
53
- '52': number;
54
- '53': number;
55
- '54': number;
56
- '55': number;
57
- '56': number;
58
- '57': number;
59
- '58': number;
60
- '59': number;
61
- '60': number;
62
- '61': number;
63
- '62': number;
64
- '63': number;
65
- '64': number;
66
- '65': number;
67
- '66': number;
68
- '67': number;
69
- '68': number;
70
- '69': number;
71
- '70': number;
72
- '71': number;
73
- '72': number;
74
- '73': number;
75
- '74': number;
76
- '75': number;
77
- '76': number;
78
- '77': number;
79
- '78': number;
80
- '79': number;
81
- '80': number;
82
- '81': number;
83
- '82': number;
84
- '83': number;
85
- '84': number;
86
- '85': number;
87
- '86': number;
88
- '87': number;
89
- '88': number;
90
- '89': number;
91
- '90': number;
92
- '91': number;
93
- '92': number;
94
- '93': number;
95
- '94': number;
96
- '95': number;
97
- '96': number;
98
- '97': number;
99
- '98': number;
100
- '99': number;
101
- '100': number;
102
- '101': number;
103
- '102': number;
104
- '103': number;
105
- '104': number;
106
- '105': number;
107
- '106': number;
108
- '107': number;
109
- '108': number;
110
- '109': number;
111
- '110': number;
112
- '111': number;
113
- '112': number;
114
- '113': number;
115
- '114': number;
116
- };
117
- declare const Utils: {
118
- isValidChapterId: (id: string | number) => boolean;
119
- isValidJuz: (juz: string | number) => boolean;
120
- isValidRub: (rub: string | number) => boolean;
121
- isValidHizb: (hizb: string | number) => boolean;
122
- isValidQuranPage: (page: string | number) => boolean;
123
- isValidVerseKey: (key: string) => boolean;
124
- };
125
- export default Utils;
@@ -1,3 +0,0 @@
1
- export declare const API_BASE_URL = "https://api.quran.com/api/v4/";
2
- export declare const makeUrl: (url: string, params?: Record<string, unknown> | undefined) => string;
3
- export declare const fetcher: <T extends object>(url: string, params?: Record<string, unknown>) => Promise<T>;
@@ -1,52 +0,0 @@
1
- import { ChapterRecitation, VerseRecitation, ChapterId, HizbNumber, JuzNumber, Language, PageNumber, Pagination, RubNumber, VerseKey, VerseRecitationField } from '../../types';
2
- declare const audio: {
3
- findAllChapterRecitations: (reciterId: string, options?: Partial<{
4
- language: Language;
5
- }> | undefined) => Promise<ChapterRecitation[]>;
6
- findChapterRecitationById: (chapterId: ChapterId, reciterId: string, options?: Partial<{
7
- language: Language;
8
- }> | undefined) => Promise<ChapterRecitation>;
9
- findVerseRecitationsByChapter: (chapterId: ChapterId, recitationId: string, options?: Partial<{
10
- language: Language;
11
- fields: Partial<Record<VerseRecitationField, boolean>>;
12
- }> | undefined) => Promise<{
13
- audioFiles: VerseRecitation[];
14
- pagination: Pagination;
15
- }>;
16
- findVerseRecitationsByJuz: (juz: JuzNumber, recitationId: string, options?: Partial<{
17
- language: Language;
18
- fields: Partial<Record<VerseRecitationField, boolean>>;
19
- }> | undefined) => Promise<{
20
- audioFiles: VerseRecitation[];
21
- pagination: Pagination;
22
- }>;
23
- findVerseRecitationsByPage: (page: PageNumber, recitationId: string, options?: Partial<{
24
- language: Language;
25
- fields: Partial<Record<VerseRecitationField, boolean>>;
26
- }> | undefined) => Promise<{
27
- audioFiles: VerseRecitation[];
28
- pagination: Pagination;
29
- }>;
30
- findVerseRecitationsByRub: (rub: RubNumber, recitationId: string, options?: Partial<{
31
- language: Language;
32
- fields: Partial<Record<VerseRecitationField, boolean>>;
33
- }> | undefined) => Promise<{
34
- audioFiles: VerseRecitation[];
35
- pagination: Pagination;
36
- }>;
37
- findVerseRecitationsByHizb: (hizb: HizbNumber, recitationId: string, options?: Partial<{
38
- language: Language;
39
- fields: Partial<Record<VerseRecitationField, boolean>>;
40
- }> | undefined) => Promise<{
41
- audioFiles: VerseRecitation[];
42
- pagination: Pagination;
43
- }>;
44
- findVerseRecitationsByKey: (key: VerseKey, recitationId: string, options?: Partial<{
45
- language: Language;
46
- fields: Partial<Record<VerseRecitationField, boolean>>;
47
- }> | undefined) => Promise<{
48
- audioFiles: VerseRecitation[];
49
- pagination: Pagination;
50
- }>;
51
- };
52
- export default audio;
@@ -1,13 +0,0 @@
1
- import { Chapter, ChapterId, ChapterInfo, Language } from '../../types';
2
- declare const chapters: {
3
- findAll: (options?: Partial<{
4
- language: Language;
5
- }> | undefined) => Promise<Chapter[]>;
6
- findById: (id: ChapterId, options?: Partial<{
7
- language: Language;
8
- }> | undefined) => Promise<Chapter>;
9
- findInfoById: (id: ChapterId, options?: Partial<{
10
- language: Language;
11
- }> | undefined) => Promise<ChapterInfo>;
12
- };
13
- export default chapters;
@@ -1,173 +0,0 @@
1
- declare const v4: {
2
- chapters: {
3
- findAll: (options?: Partial<{
4
- language: import("../..").Language;
5
- }> | undefined) => Promise<import("../..").Chapter[]>;
6
- findById: (id: import("../..").ChapterId, options?: Partial<{
7
- language: import("../..").Language;
8
- }> | undefined) => Promise<import("../..").Chapter>;
9
- findInfoById: (id: import("../..").ChapterId, options?: Partial<{
10
- language: import("../..").Language;
11
- }> | undefined) => Promise<import("../..").ChapterInfo>;
12
- };
13
- verses: {
14
- findByKey: (key: import("../..").VerseKey, options?: Partial<{
15
- language: import("../..").Language;
16
- reciter: string | number;
17
- words: boolean;
18
- translations: string[] | number[];
19
- tafsirs: string[] | number[];
20
- wordFields: Partial<Record<import("../..").WordField, boolean>>;
21
- translationFields: Partial<Record<import("../..").TranslationField, boolean>>;
22
- fields: Partial<Record<import("../..").VerseField, boolean>>;
23
- page: number;
24
- perPage: number;
25
- }> | undefined) => Promise<import("../..").Verse>;
26
- findByChapter: (id: import("../..").ChapterId, options?: Partial<{
27
- language: import("../..").Language;
28
- reciter: string | number;
29
- words: boolean;
30
- translations: string[] | number[];
31
- tafsirs: string[] | number[];
32
- wordFields: Partial<Record<import("../..").WordField, boolean>>;
33
- translationFields: Partial<Record<import("../..").TranslationField, boolean>>;
34
- fields: Partial<Record<import("../..").VerseField, boolean>>;
35
- page: number;
36
- perPage: number;
37
- }> | undefined) => Promise<import("../..").Verse[]>;
38
- findByPage: (page: import("../..").PageNumber, options?: Partial<{
39
- language: import("../..").Language;
40
- reciter: string | number;
41
- words: boolean;
42
- translations: string[] | number[];
43
- tafsirs: string[] | number[];
44
- wordFields: Partial<Record<import("../..").WordField, boolean>>;
45
- translationFields: Partial<Record<import("../..").TranslationField, boolean>>;
46
- fields: Partial<Record<import("../..").VerseField, boolean>>;
47
- page: number;
48
- perPage: number;
49
- }> | undefined) => Promise<import("../..").Verse[]>;
50
- findByJuz: (juz: import("../..").JuzNumber, options?: Partial<{
51
- language: import("../..").Language;
52
- reciter: string | number;
53
- words: boolean;
54
- translations: string[] | number[];
55
- tafsirs: string[] | number[];
56
- wordFields: Partial<Record<import("../..").WordField, boolean>>;
57
- translationFields: Partial<Record<import("../..").TranslationField, boolean>>;
58
- fields: Partial<Record<import("../..").VerseField, boolean>>;
59
- page: number;
60
- perPage: number;
61
- }> | undefined) => Promise<import("../..").Verse[]>;
62
- findRandom: (options?: Partial<{
63
- language: import("../..").Language;
64
- reciter: string | number;
65
- words: boolean;
66
- translations: string[] | number[];
67
- tafsirs: string[] | number[];
68
- wordFields: Partial<Record<import("../..").WordField, boolean>>;
69
- translationFields: Partial<Record<import("../..").TranslationField, boolean>>;
70
- fields: Partial<Record<import("../..").VerseField, boolean>>;
71
- page: number;
72
- perPage: number;
73
- }> | undefined) => Promise<import("../..").Verse>;
74
- };
75
- juzs: {
76
- findAll: () => Promise<import("../..").Juz[]>;
77
- };
78
- audio: {
79
- findAllChapterRecitations: (reciterId: string, options?: Partial<{
80
- language: import("../..").Language;
81
- }> | undefined) => Promise<import("../..").ChapterRecitation[]>;
82
- findChapterRecitationById: (chapterId: import("../..").ChapterId, reciterId: string, options?: Partial<{
83
- language: import("../..").Language;
84
- }> | undefined) => Promise<import("../..").ChapterRecitation>;
85
- findVerseRecitationsByChapter: (chapterId: import("../..").ChapterId, recitationId: string, options?: Partial<{
86
- language: import("../..").Language;
87
- fields: Partial<Record<import("../..").VerseRecitationField, boolean>>;
88
- }> | undefined) => Promise<{
89
- audioFiles: import("../..").VerseRecitation[];
90
- pagination: import("../..").Pagination;
91
- }>;
92
- findVerseRecitationsByJuz: (juz: import("../..").JuzNumber, recitationId: string, options?: Partial<{
93
- language: import("../..").Language;
94
- fields: Partial<Record<import("../..").VerseRecitationField, boolean>>;
95
- }> | undefined) => Promise<{
96
- audioFiles: import("../..").VerseRecitation[];
97
- pagination: import("../..").Pagination;
98
- }>;
99
- findVerseRecitationsByPage: (page: import("../..").PageNumber, recitationId: string, options?: Partial<{
100
- language: import("../..").Language;
101
- fields: Partial<Record<import("../..").VerseRecitationField, boolean>>;
102
- }> | undefined) => Promise<{
103
- audioFiles: import("../..").VerseRecitation[];
104
- pagination: import("../..").Pagination;
105
- }>;
106
- findVerseRecitationsByRub: (rub: import("../..").RubNumber, recitationId: string, options?: Partial<{
107
- language: import("../..").Language;
108
- fields: Partial<Record<import("../..").VerseRecitationField, boolean>>;
109
- }> | undefined) => Promise<{
110
- audioFiles: import("../..").VerseRecitation[];
111
- pagination: import("../..").Pagination;
112
- }>;
113
- findVerseRecitationsByHizb: (hizb: import("../..").HizbNumber, recitationId: string, options?: Partial<{
114
- language: import("../..").Language;
115
- fields: Partial<Record<import("../..").VerseRecitationField, boolean>>;
116
- }> | undefined) => Promise<{
117
- audioFiles: import("../..").VerseRecitation[];
118
- pagination: import("../..").Pagination;
119
- }>;
120
- findVerseRecitationsByKey: (key: import("../..").VerseKey, recitationId: string, options?: Partial<{
121
- language: import("../..").Language;
122
- fields: Partial<Record<import("../..").VerseRecitationField, boolean>>;
123
- }> | undefined) => Promise<{
124
- audioFiles: import("../..").VerseRecitation[];
125
- pagination: import("../..").Pagination;
126
- }>;
127
- };
128
- resources: {
129
- findAllRecitations: (options?: Partial<{
130
- language: import("../..").Language;
131
- }> | undefined) => Promise<import("../..").RecitationResource[]>;
132
- findAllTranslations: (options?: Partial<{
133
- language: import("../..").Language;
134
- }> | undefined) => Promise<import("../..").TranslationResource[]>;
135
- findAllTafsirs: (options?: Partial<{
136
- language: import("../..").Language;
137
- }> | undefined) => Promise<import("../..").TafsirResource[]>;
138
- findAllRecitationStyles: () => Promise<import("../..").RecitationStylesResource>;
139
- findAllLanguages: (options?: Partial<{
140
- language: import("../..").Language;
141
- }> | undefined) => Promise<import("../..").LanguageResource[]>;
142
- findVerseMedia: (options?: Partial<{
143
- language: import("../..").Language;
144
- }> | undefined) => Promise<import("../..").VerseMediaResource>;
145
- findAllChapterReciters: (options?: Partial<{
146
- language: import("../..").Language;
147
- }> | undefined) => Promise<import("../..").ChapterReciterResource[]>;
148
- findAllChapterInfos: (options?: Partial<{
149
- language: import("../..").Language;
150
- }> | undefined) => Promise<import("../..").ChapterInfoResource[]>;
151
- };
152
- search: {
153
- search: (q: string, options?: Partial<{
154
- language: import("../..").Language;
155
- size: number;
156
- page: number;
157
- }> | undefined) => Promise<{
158
- query: string;
159
- totalResults: number;
160
- currentPage: number;
161
- totalPages: number;
162
- results?: {
163
- verseKey: string;
164
- verse_id: number;
165
- text: string;
166
- highlighted: string;
167
- words: import("../..").Word[];
168
- translations: import("../..").Translation[];
169
- }[] | undefined;
170
- }>;
171
- };
172
- };
173
- export default v4;
@@ -1,5 +0,0 @@
1
- import { Juz } from '../../types';
2
- declare const juzs: {
3
- findAll: () => Promise<Juz[]>;
4
- };
5
- export default juzs;
@@ -1,26 +0,0 @@
1
- import { ChapterInfoResource, ChapterReciterResource, Language, LanguageResource, RecitationResource, RecitationStylesResource, TafsirResource, TranslationResource, VerseMediaResource } from '../../types';
2
- declare const resources: {
3
- findAllRecitations: (options?: Partial<{
4
- language: Language;
5
- }> | undefined) => Promise<RecitationResource[]>;
6
- findAllTranslations: (options?: Partial<{
7
- language: Language;
8
- }> | undefined) => Promise<TranslationResource[]>;
9
- findAllTafsirs: (options?: Partial<{
10
- language: Language;
11
- }> | undefined) => Promise<TafsirResource[]>;
12
- findAllRecitationStyles: () => Promise<RecitationStylesResource>;
13
- findAllLanguages: (options?: Partial<{
14
- language: Language;
15
- }> | undefined) => Promise<LanguageResource[]>;
16
- findVerseMedia: (options?: Partial<{
17
- language: Language;
18
- }> | undefined) => Promise<VerseMediaResource>;
19
- findAllChapterReciters: (options?: Partial<{
20
- language: Language;
21
- }> | undefined) => Promise<ChapterReciterResource[]>;
22
- findAllChapterInfos: (options?: Partial<{
23
- language: Language;
24
- }> | undefined) => Promise<ChapterInfoResource[]>;
25
- };
26
- export default resources;
@@ -1,22 +0,0 @@
1
- import { Language } from '../../types';
2
- declare const searchApi: {
3
- search: (q: string, options?: Partial<{
4
- language: Language;
5
- size: number;
6
- page: number;
7
- }> | undefined) => Promise<{
8
- query: string;
9
- totalResults: number;
10
- currentPage: number;
11
- totalPages: number;
12
- results?: {
13
- verseKey: string;
14
- verse_id: number;
15
- text: string;
16
- highlighted: string;
17
- words: import("../../types").Word[];
18
- translations: import("../../types").Translation[];
19
- }[] | undefined;
20
- }>;
21
- };
22
- export default searchApi;
@@ -1,64 +0,0 @@
1
- import { ChapterId, JuzNumber, Language, PageNumber, TranslationField, Verse, VerseField, VerseKey, WordField } from '../../types';
2
- declare const verses: {
3
- findByKey: (key: VerseKey, options?: Partial<{
4
- language: Language;
5
- reciter: string | number;
6
- words: boolean;
7
- translations: string[] | number[];
8
- tafsirs: string[] | number[];
9
- wordFields: Partial<Record<WordField, boolean>>;
10
- translationFields: Partial<Record<TranslationField, boolean>>;
11
- fields: Partial<Record<VerseField, boolean>>;
12
- page: number;
13
- perPage: number;
14
- }> | undefined) => Promise<Verse>;
15
- findByChapter: (id: ChapterId, options?: Partial<{
16
- language: Language;
17
- reciter: string | number;
18
- words: boolean;
19
- translations: string[] | number[];
20
- tafsirs: string[] | number[];
21
- wordFields: Partial<Record<WordField, boolean>>;
22
- translationFields: Partial<Record<TranslationField, boolean>>;
23
- fields: Partial<Record<VerseField, boolean>>;
24
- page: number;
25
- perPage: number;
26
- }> | undefined) => Promise<Verse[]>;
27
- findByPage: (page: PageNumber, options?: Partial<{
28
- language: Language;
29
- reciter: string | number;
30
- words: boolean;
31
- translations: string[] | number[];
32
- tafsirs: string[] | number[];
33
- wordFields: Partial<Record<WordField, boolean>>;
34
- translationFields: Partial<Record<TranslationField, boolean>>;
35
- fields: Partial<Record<VerseField, boolean>>;
36
- page: number;
37
- perPage: number;
38
- }> | undefined) => Promise<Verse[]>;
39
- findByJuz: (juz: JuzNumber, options?: Partial<{
40
- language: Language;
41
- reciter: string | number;
42
- words: boolean;
43
- translations: string[] | number[];
44
- tafsirs: string[] | number[];
45
- wordFields: Partial<Record<WordField, boolean>>;
46
- translationFields: Partial<Record<TranslationField, boolean>>;
47
- fields: Partial<Record<VerseField, boolean>>;
48
- page: number;
49
- perPage: number;
50
- }> | undefined) => Promise<Verse[]>;
51
- findRandom: (options?: Partial<{
52
- language: Language;
53
- reciter: string | number;
54
- words: boolean;
55
- translations: string[] | number[];
56
- tafsirs: string[] | number[];
57
- wordFields: Partial<Record<WordField, boolean>>;
58
- translationFields: Partial<Record<TranslationField, boolean>>;
59
- fields: Partial<Record<VerseField, boolean>>;
60
- page: number;
61
- perPage: number;
62
- }> | undefined) => Promise<Verse>;
63
- };
64
- export default verses;
@@ -1,4 +0,0 @@
1
- import { NumberRange, NumberUnionToString } from './utils';
2
- declare type _ChapterId = NumberRange<1, 115>;
3
- export declare type ChapterId = _ChapterId | NumberUnionToString<_ChapterId>;
4
- export {};
@@ -1,4 +0,0 @@
1
- import { NumberRange, NumberUnionToString } from './utils';
2
- declare type _HizbNumber = NumberRange<1, 61>;
3
- export declare type HizbNumber = _HizbNumber | NumberUnionToString<_HizbNumber>;
4
- export {};
@@ -1,4 +0,0 @@
1
- import { NumberRange, NumberUnionToString } from './utils';
2
- declare type _JuzNumber = NumberRange<1, 31>;
3
- export declare type JuzNumber = _JuzNumber | NumberUnionToString<_JuzNumber>;
4
- export {};
@@ -1,4 +0,0 @@
1
- import { NumberRange, NumberUnionToString } from './utils';
2
- declare type _PageNumber = NumberRange<1, 605>;
3
- export declare type PageNumber = _PageNumber | NumberUnionToString<_PageNumber>;
4
- export {};
@@ -1,4 +0,0 @@
1
- import { NumberRange, NumberUnionToString } from './utils';
2
- declare type _RubNumber = NumberRange<1, 241>;
3
- export declare type RubNumber = _RubNumber | NumberUnionToString<_RubNumber>;
4
- export {};
@@ -1,2 +0,0 @@
1
- import { NumberRange } from './utils';
2
- export declare type VerseKey = `1:${NumberRange<1, 8>}` | `2:${NumberRange<1, 287>}` | `3:${NumberRange<1, 201>}` | `4:${NumberRange<1, 177>}` | `5:${NumberRange<1, 121>}` | `6:${NumberRange<1, 166>}` | `7:${NumberRange<1, 207>}` | `8:${NumberRange<1, 76>}` | `9:${NumberRange<1, 130>}` | `10:${NumberRange<1, 110>}` | `11:${NumberRange<1, 124>}` | `12:${NumberRange<1, 112>}` | `13:${NumberRange<1, 44>}` | `14:${NumberRange<1, 53>}` | `15:${NumberRange<1, 100>}` | `16:${NumberRange<1, 129>}` | `17:${NumberRange<1, 112>}` | `18:${NumberRange<1, 111>}` | `19:${NumberRange<1, 99>}` | `20:${NumberRange<1, 136>}` | `21:${NumberRange<1, 113>}` | `22:${NumberRange<1, 79>}` | `23:${NumberRange<1, 119>}` | `24:${NumberRange<1, 65>}` | `25:${NumberRange<1, 78>}` | `26:${NumberRange<1, 228>}` | `27:${NumberRange<1, 94>}` | `28:${NumberRange<1, 89>}` | `29:${NumberRange<1, 70>}` | `30:${NumberRange<1, 61>}` | `31:${NumberRange<1, 35>}` | `32:${NumberRange<1, 31>}` | `33:${NumberRange<1, 74>}` | `34:${NumberRange<1, 55>}` | `35:${NumberRange<1, 46>}` | `36:${NumberRange<1, 84>}` | `37:${NumberRange<1, 183>}` | `38:${NumberRange<1, 89>}` | `39:${NumberRange<1, 76>}` | `40:${NumberRange<1, 86>}` | `41:${NumberRange<1, 55>}` | `42:${NumberRange<1, 54>}` | `43:${NumberRange<1, 90>}` | `44:${NumberRange<1, 60>}` | `45:${NumberRange<1, 38>}` | `46:${NumberRange<1, 36>}` | `47:${NumberRange<1, 39>}` | `48:${NumberRange<1, 30>}` | `49:${NumberRange<1, 19>}` | `50:${NumberRange<1, 46>}` | `51:${NumberRange<1, 61>}` | `52:${NumberRange<1, 50>}` | `53:${NumberRange<1, 63>}` | `54:${NumberRange<1, 56>}` | `55:${NumberRange<1, 79>}` | `56:${NumberRange<1, 97>}` | `57:${NumberRange<1, 30>}` | `58:${NumberRange<1, 23>}` | `59:${NumberRange<1, 25>}` | `60:${NumberRange<1, 14>}` | `61:${NumberRange<1, 15>}` | `62:${NumberRange<1, 12>}` | `63:${NumberRange<1, 12>}` | `64:${NumberRange<1, 19>}` | `65:${NumberRange<1, 13>}` | `66:${NumberRange<1, 13>}` | `67:${NumberRange<1, 31>}` | `68:${NumberRange<1, 53>}` | `69:${NumberRange<1, 53>}` | `70:${NumberRange<1, 45>}` | `71:${NumberRange<1, 29>}` | `72:${NumberRange<1, 29>}` | `73:${NumberRange<1, 21>}` | `74:${NumberRange<1, 57>}` | `75:${NumberRange<1, 41>}` | `76:${NumberRange<1, 32>}` | `77:${NumberRange<1, 51>}` | `78:${NumberRange<1, 41>}` | `79:${NumberRange<1, 47>}` | `80:${NumberRange<1, 43>}` | `81:${NumberRange<1, 30>}` | `82:${NumberRange<1, 20>}` | `83:${NumberRange<1, 37>}` | `84:${NumberRange<1, 26>}` | `85:${NumberRange<1, 23>}` | `86:${NumberRange<1, 18>}` | `87:${NumberRange<1, 20>}` | `88:${NumberRange<1, 27>}` | `89:${NumberRange<1, 31>}` | `90:${NumberRange<1, 21>}` | `91:${NumberRange<1, 16>}` | `92:${NumberRange<1, 22>}` | `93:${NumberRange<1, 12>}` | `94:${NumberRange<1, 9>}` | `95:${NumberRange<1, 9>}` | `96:${NumberRange<1, 20>}` | `97:${NumberRange<1, 6>}` | `98:${NumberRange<1, 9>}` | `99:${NumberRange<1, 9>}` | `100:${NumberRange<1, 12>}` | `101:${NumberRange<1, 12>}` | `102:${NumberRange<1, 9>}` | `103:${NumberRange<1, 4>}` | `104:${NumberRange<1, 10>}` | `105:${NumberRange<1, 6>}` | `106:${NumberRange<1, 5>}` | `107:${NumberRange<1, 8>}` | `108:${NumberRange<1, 4>}` | `109:${NumberRange<1, 7>}` | `110:${NumberRange<1, 4>}` | `111:${NumberRange<1, 6>}` | `112:${NumberRange<1, 5>}` | `113:${NumberRange<1, 6>}` | `114:${NumberRange<1, 7>}`;
@@ -1,18 +0,0 @@
1
- import { Translation } from './Translation';
2
- import { Word } from './Word';
3
- export interface SearchResponse {
4
- search: {
5
- query: string;
6
- totalResults: number;
7
- currentPage: number;
8
- totalPages: number;
9
- results?: {
10
- verseKey: string;
11
- verse_id: number;
12
- text: string;
13
- highlighted: string;
14
- words: Word[];
15
- translations: Translation[];
16
- }[];
17
- };
18
- }
@@ -1,17 +0,0 @@
1
- import { VerseKey } from '../VerseKey';
2
- import { Segment } from './Segment';
3
- export interface ChapterRecitation {
4
- id: number;
5
- chapterId: number;
6
- fileSize: number;
7
- format: string;
8
- audioUrl: string;
9
- }
10
- export interface VerseRecitation {
11
- verseKey: VerseKey;
12
- url: string;
13
- id?: number;
14
- chapterId?: number;
15
- segments?: Segment[];
16
- format?: string;
17
- }
@@ -1,8 +0,0 @@
1
- import { Segment } from './Segment';
2
- export interface AudioResponse {
3
- url?: string;
4
- duration?: number;
5
- format?: string;
6
- verseKey: string;
7
- segments?: Segment[];
8
- }
@@ -1,14 +0,0 @@
1
- import { TranslatedName } from './TranslatedName';
2
- export interface Chapter {
3
- id: number;
4
- versesCount: number;
5
- bismillahPre: boolean;
6
- revelationOrder: number;
7
- revelationPlace: string;
8
- pages: Array<number>;
9
- nameComplex: string;
10
- nameSimple: string;
11
- transliteratedName: string;
12
- nameArabic: string;
13
- translatedName: TranslatedName;
14
- }
@@ -1,8 +0,0 @@
1
- export interface ChapterInfo {
2
- id: number;
3
- chapterId: number;
4
- text: string;
5
- shortText: string;
6
- source: string;
7
- languageName?: string;
8
- }
@@ -1,6 +0,0 @@
1
- export interface Footnote {
2
- id: number | string;
3
- text: string;
4
- languageName?: string;
5
- languageId?: number;
6
- }
@@ -1,8 +0,0 @@
1
- export interface Juz {
2
- id: number;
3
- juzNumber: number;
4
- verseMapping: Record<number, string>;
5
- firstVerseId: number;
6
- lastVerseId: number;
7
- versesCount: number;
8
- }
@@ -1,7 +0,0 @@
1
- export interface Pagination {
2
- perPage: number;
3
- currentPage: number;
4
- nextPage: number;
5
- totalPages: number;
6
- totalRecords: number;
7
- }
@@ -1,21 +0,0 @@
1
- export interface Reciter {
2
- id: number;
3
- name: string;
4
- recitationStyle: string;
5
- relativePath: string;
6
- profilePicture?: string;
7
- coverImage?: string;
8
- bio?: string;
9
- qirat?: {
10
- languageName: string;
11
- name: string;
12
- };
13
- style?: {
14
- languageName: string;
15
- name: string;
16
- };
17
- translatedName?: {
18
- languageName: string;
19
- name: string;
20
- };
21
- }