@quranjs/api 1.2.0 → 1.5.0

package/src/sdk/v4/resources.ts

@@ -14,15 +14,15 @@ import {
 } from '../../types';
 import { fetcher } from './_fetcher';
 
-type GetResourcesOptions = Partial<{
+type GetResourceOptions = Partial<{
   language: Language;
 }>;
 
-const defaultOptions: GetResourcesOptions = {
+const defaultOptions: GetResourceOptions = {
   language: Language.ARABIC,
 };
 
-const getResourcesOptions = (options: GetResourcesOptions = {}) => {
+const getResourcesOptions = (options: GetResourceOptions = {}) => {
   const final: any = { ...defaultOptions, ...options };
   return final;
 };
@@ -30,11 +30,11 @@ const getResourcesOptions = (options: GetResourcesOptions = {}) => {
 /**
  * Get all recitations.
  * @description https://quran.api-docs.io/v4/resources/recitations
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllRecitations()
  */
-const findAllRecitations = async (options?: GetResourcesOptions) => {
+const findAllRecitations = async (options?: GetResourceOptions) => {
   const params = getResourcesOptions(options);
   const { recitations } = await fetcher<{
     recitations: RecitationResource[];
@@ -48,11 +48,11 @@ const findAllRecitations = async (options?: GetResourcesOptions) => {
  * Get all recitation info.
  * @description https://quran.api-docs.io/v4/resources/recitation-info
  * @param {string} id recitation id
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findRecitationInfo('1')
  */
-// const findRecitationInfo = async (id: string, options?: GetResourcesOptions) => {
+// const findRecitationInfo = async (id: string, options?: GetResourceOptions) => {
 //   const params = getResourcesOptions(options);
 //   const { info } = await fetcher<{
 //     info: RecitationInfoResource;
@@ -64,11 +64,11 @@ const findAllRecitations = async (options?: GetResourcesOptions) => {
 /**
  * Get all translations.
  * @description https://quran.api-docs.io/v4/resources/translations
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllTranslations()
  */
-const findAllTranslations = async (options?: GetResourcesOptions) => {
+const findAllTranslations = async (options?: GetResourceOptions) => {
   const params = getResourcesOptions(options);
   const { translations } = await fetcher<{
     translations: TranslationResource[];
@@ -82,11 +82,11 @@ const findAllTranslations = async (options?: GetResourcesOptions) => {
  * Get translation info.
  * @description https://quran.api-docs.io/v4/resources/translation-info
  * @param {string} id translation id
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findTranslationInfo('169')
  */
-// const findTranslationInfo = async (id: string, options?: GetResourcesOptions) => {
+// const findTranslationInfo = async (id: string, options?: GetResourceOptions) => {
 //   const params = getResourcesOptions(options);
 //   const { info } = await fetcher<{
 //     info: TranslationInfoResource;
@@ -98,11 +98,11 @@ const findAllTranslations = async (options?: GetResourcesOptions) => {
 /**
  * Get all tafsirs.
  * @description https://quran.api-docs.io/v4/resources/tafsirs
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllTafsirs()
  */
-const findAllTafsirs = async (options?: GetResourcesOptions) => {
+const findAllTafsirs = async (options?: GetResourceOptions) => {
   const params = getResourcesOptions(options);
   const { tafsirs } = await fetcher<{
     tafsirs: TafsirResource[];
@@ -116,11 +116,11 @@ const findAllTafsirs = async (options?: GetResourcesOptions) => {
  * Get tafsir info.
  * @description https://quran.api-docs.io/v4/resources/tafsirs-info
  * @param {string} id tafsir id
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findTranslationInfo('1')
  */
-// const findTafsirInfo = async (id: string, options?: GetResourcesOptions) => {
+// const findTafsirInfo = async (id: string, options?: GetResourceOptions) => {
 //   const params = getResourcesOptions(options);
 //   const { info } = await fetcher<{
 //     info: TafsirInfoResource;
@@ -146,11 +146,11 @@ const findAllRecitationStyles = async () => {
 /**
  * Get all languages.
  * @description https://quran.api-docs.io/v4/resources/languages
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllLanguages()
  */
-const findAllLanguages = async (options?: GetResourcesOptions) => {
+const findAllLanguages = async (options?: GetResourceOptions) => {
   const params = getResourcesOptions(options);
   const { languages } = await fetcher<{
     languages: LanguageResource[];
@@ -162,11 +162,11 @@ const findAllLanguages = async (options?: GetResourcesOptions) => {
 /**
  * Get all chapter infos.
  * @description https://quran.api-docs.io/v4/resources/chapter-info
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllChapterInfos()
  */
-const findAllChapterInfos = async (options?: GetResourcesOptions) => {
+const findAllChapterInfos = async (options?: GetResourceOptions) => {
   const params = getResourcesOptions(options);
   const { chapterInfos } = await fetcher<{
     chapterInfos: ChapterInfoResource[];
@@ -178,11 +178,11 @@ const findAllChapterInfos = async (options?: GetResourcesOptions) => {
 /**
  * Get verse media.
  * @description https://quran.api-docs.io/v4/resources/verse_media
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findVerseMedia()
  */
-const findVerseMedia = async (options?: GetResourcesOptions) => {
+const findVerseMedia = async (options?: GetResourceOptions) => {
   const params = getResourcesOptions(options);
   const { verseMedia } = await fetcher<{
     verseMedia: VerseMediaResource;
@@ -194,11 +194,11 @@ const findVerseMedia = async (options?: GetResourcesOptions) => {
 /**
  * Get all chapter reciters.
  * @description https://quran.api-docs.io/v4/resources/list-of-chapter-reciters
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllChapterReciters()
  */
-const findAllChapterReciters = async (options?: GetResourcesOptions) => {
+const findAllChapterReciters = async (options?: GetResourceOptions) => {
   const params = getResourcesOptions(options);
   const { reciters } = await fetcher<{
     reciters: ChapterReciterResource[];

package/src/sdk/v4/search.ts

@@ -20,13 +20,13 @@ const getSearchOptions = (q: string, options: SearchOptions = {}) => {
 /**
  * Search
  * @description https://quran.api-docs.io/v4/search/KfCmk4KQYbtyK9adj
- * @param q search query
- * @param options search options
+ * @param {string} q search query
+ * @param {SearchOptions} options
  * @example
- * quran.v4.search.search('الله')
- * quran.v4.search.search('الله', { language: Language.ENGLISH })
- * quran.v4.search.search('الله', { language: Language.ENGLISH, size: 10 })
- * quran.v4.search.search('الله', { language: Language.ENGLISH, page: 2 })
+ * quran.v4.search.search('نور')
+ * quran.v4.search.search('نور', { language: Language.ENGLISH })
+ * quran.v4.search.search('نور', { language: Language.ENGLISH, size: 10 })
+ * quran.v4.search.search('نور', { language: Language.ENGLISH, page: 2 })
  */
 const search = async (q: string, options?: SearchOptions) => {
   const params = getSearchOptions(q, options);

package/src/types/ChapterId.ts

@@ -1,115 +1,4 @@
-export type ChapterId =
-  | '1'
-  | '2'
-  | '3'
-  | '4'
-  | '5'
-  | '6'
-  | '7'
-  | '8'
-  | '9'
-  | '10'
-  | '11'
-  | '12'
-  | '13'
-  | '14'
-  | '15'
-  | '16'
-  | '17'
-  | '18'
-  | '19'
-  | '20'
-  | '21'
-  | '22'
-  | '23'
-  | '24'
-  | '25'
-  | '26'
-  | '27'
-  | '28'
-  | '29'
-  | '30'
-  | '31'
-  | '32'
-  | '33'
-  | '34'
-  | '35'
-  | '36'
-  | '37'
-  | '38'
-  | '39'
-  | '40'
-  | '41'
-  | '42'
-  | '43'
-  | '44'
-  | '45'
-  | '46'
-  | '47'
-  | '48'
-  | '49'
-  | '50'
-  | '51'
-  | '52'
-  | '53'
-  | '54'
-  | '55'
-  | '56'
-  | '57'
-  | '58'
-  | '59'
-  | '60'
-  | '61'
-  | '62'
-  | '63'
-  | '64'
-  | '65'
-  | '66'
-  | '67'
-  | '68'
-  | '69'
-  | '70'
-  | '71'
-  | '72'
-  | '73'
-  | '74'
-  | '75'
-  | '76'
-  | '77'
-  | '78'
-  | '79'
-  | '80'
-  | '81'
-  | '82'
-  | '83'
-  | '84'
-  | '85'
-  | '86'
-  | '87'
-  | '88'
-  | '89'
-  | '90'
-  | '91'
-  | '92'
-  | '93'
-  | '94'
-  | '95'
-  | '96'
-  | '97'
-  | '98'
-  | '99'
-  | '100'
-  | '101'
-  | '102'
-  | '103'
-  | '104'
-  | '105'
-  | '106'
-  | '107'
-  | '108'
-  | '109'
-  | '110'
-  | '111'
-  | '112'
-  | '113'
-  | '114';
+import { NumberRange, NumberUnionToString } from './utils';
+
+type _ChapterId = NumberRange<1, 115>;
+export type ChapterId = _ChapterId | NumberUnionToString<_ChapterId>;

package/src/types/HizbNumber.ts

@@ -1,61 +1,4 @@
-export type HizbNumber =
-  | '1'
-  | '2'
-  | '3'
-  | '4'
-  | '5'
-  | '6'
-  | '7'
-  | '8'
-  | '9'
-  | '10'
-  | '11'
-  | '12'
-  | '13'
-  | '14'
-  | '15'
-  | '16'
-  | '17'
-  | '18'
-  | '19'
-  | '20'
-  | '21'
-  | '22'
-  | '23'
-  | '24'
-  | '25'
-  | '26'
-  | '27'
-  | '28'
-  | '29'
-  | '30'
-  | '31'
-  | '32'
-  | '33'
-  | '34'
-  | '35'
-  | '36'
-  | '37'
-  | '38'
-  | '39'
-  | '40'
-  | '41'
-  | '42'
-  | '43'
-  | '44'
-  | '45'
-  | '46'
-  | '47'
-  | '48'
-  | '49'
-  | '50'
-  | '51'
-  | '52'
-  | '53'
-  | '54'
-  | '55'
-  | '56'
-  | '57'
-  | '58'
-  | '59'
-  | '60';
+import { NumberRange, NumberUnionToString } from './utils';
+
+type _HizbNumber = NumberRange<1, 61>;
+export type HizbNumber = _HizbNumber | NumberUnionToString<_HizbNumber>;

package/src/types/JuzNumber.ts

@@ -1,31 +1,4 @@
-export type JuzNumber =
-  | '1'
-  | '2'
-  | '3'
-  | '4'
-  | '5'
-  | '6'
-  | '7'
-  | '8'
-  | '9'
-  | '10'
-  | '11'
-  | '12'
-  | '13'
-  | '14'
-  | '15'
-  | '16'
-  | '17'
-  | '18'
-  | '19'
-  | '20'
-  | '21'
-  | '22'
-  | '23'
-  | '24'
-  | '25'
-  | '26'
-  | '27'
-  | '28'
-  | '29'
-  | '30';
+import { NumberRange, NumberUnionToString } from './utils';
+
+type _JuzNumber = NumberRange<1, 31>;
+export type JuzNumber = _JuzNumber | NumberUnionToString<_JuzNumber>;