@quranjs/api 1.5.1 → 1.7.0

package/src/sdk/v4/audio.ts

@@ -11,52 +11,26 @@ import {
   VerseKey,
   VerseRecitationField,
 } from '../../types';
-import { decamelize } from 'humps';
 import Utils from '../utils';
-import { fetcher } from './_fetcher';
+import { fetcher, mergeApiOptions } from './_fetcher';
+import { BaseApiOptions } from '../../types/BaseApiOptions';
 
-type GetChapterRecitationOptions = Partial<{
-  language: Language;
-}>;
+type GetChapterRecitationOptions = Partial<BaseApiOptions>;
 
 const defaultChapterRecitationsOptions: GetChapterRecitationOptions = {
   language: Language.ARABIC,
 };
 
-const getChapterRecitationsOptions = (
-  options: GetChapterRecitationOptions = {}
-) => {
-  const final: any = { ...defaultChapterRecitationsOptions, ...options };
-
-  return final;
-};
-
-type GetVerseRecitationOptions = Partial<{
-  language: Language;
-  fields: Partial<Record<VerseRecitationField, boolean>>;
-}>;
+type GetVerseRecitationOptions = Partial<
+  BaseApiOptions & {
+    fields: Partial<Record<VerseRecitationField, boolean>>;
+  }
+>;
 
 const defaultVerseRecitationsOptions: GetVerseRecitationOptions = {
   language: Language.ARABIC,
 };
 
-const getVerseRecitationsOptions = (
-  options: GetVerseRecitationOptions = {}
-) => {
-  const initial = { ...defaultVerseRecitationsOptions, ...options };
-  const final: any = { language: initial.language };
-
-  if (initial.fields) {
-    const fields: string[] = [];
-    for (const [key, value] of Object.entries(initial.fields)) {
-      if (value) fields.push(decamelize(key));
-    }
-    final.fields = fields.join(',');
-  }
-
-  return final;
-};
-
 /**
  * Get all chapter recitations for specific reciter
  * @description https://quran.api-docs.io/v4/audio-recitations/list-of-all-surah-audio-files-for-specific-reciter
@@ -69,10 +43,11 @@ const findAllChapterRecitations = async (
   reciterId: string,
   options?: GetChapterRecitationOptions
 ) => {
-  const params = getChapterRecitationsOptions(options);
+  const params = mergeApiOptions(options, defaultChapterRecitationsOptions);
   const { audioFiles } = await fetcher<{ audioFiles: ChapterRecitation[] }>(
     `/chapter_recitations/${reciterId}`,
-    params
+    params,
+    options?.fetchFn
   );
   return audioFiles;
 };
@@ -93,10 +68,11 @@ const findChapterRecitationById = async (
 ) => {
   if (!Utils.isValidChapterId(chapterId)) throw new Error('Invalid chapter id');
 
-  const params = getChapterRecitationsOptions(options);
+  const params = mergeApiOptions(options, defaultChapterRecitationsOptions);
   const { audioFile } = await fetcher<{ audioFile: ChapterRecitation }>(
     `/chapter_recitations/${reciterId}/${chapterId}`,
-    params
+    params,
+    options?.fetchFn
   );
 
   return audioFile;
@@ -118,11 +94,15 @@ const findVerseRecitationsByChapter = async (
 ) => {
   if (!Utils.isValidChapterId(chapterId)) throw new Error('Invalid chapter id');
 
-  const params = getVerseRecitationsOptions(options);
+  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
   const data = await fetcher<{
     audioFiles: VerseRecitation[];
     pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_chapter/${chapterId}`, params);
+  }>(
+    `/recitations/${recitationId}/by_chapter/${chapterId}`,
+    params,
+    options?.fetchFn
+  );
 
   return data;
 };
@@ -143,11 +123,11 @@ const findVerseRecitationsByJuz = async (
 ) => {
   if (!Utils.isValidJuz(juz)) throw new Error('Invalid juz');
 
-  const params = getVerseRecitationsOptions(options);
+  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
   const data = await fetcher<{
     audioFiles: VerseRecitation[];
     pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_juz/${juz}`, params);
+  }>(`/recitations/${recitationId}/by_juz/${juz}`, params, options?.fetchFn);
 
   return data;
 };
@@ -168,11 +148,11 @@ const findVerseRecitationsByPage = async (
 ) => {
   if (!Utils.isValidQuranPage(page)) throw new Error('Invalid page');
 
-  const params = getVerseRecitationsOptions(options);
+  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
   const data = await fetcher<{
     audioFiles: VerseRecitation[];
     pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_page/${page}`, params);
+  }>(`/recitations/${recitationId}/by_page/${page}`, params, options?.fetchFn);
 
   return data;
 };
@@ -193,11 +173,11 @@ const findVerseRecitationsByRub = async (
 ) => {
   if (!Utils.isValidRub(rub)) throw new Error('Invalid rub');
 
-  const params = getVerseRecitationsOptions(options);
+  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
   const data = await fetcher<{
     audioFiles: VerseRecitation[];
     pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_rub/${rub}`, params);
+  }>(`/recitations/${recitationId}/by_rub/${rub}`, params, options?.fetchFn);
 
   return data;
 };
@@ -218,11 +198,11 @@ const findVerseRecitationsByHizb = async (
 ) => {
   if (!Utils.isValidHizb(hizb)) throw new Error('Invalid hizb');
 
-  const params = getVerseRecitationsOptions(options);
+  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
   const data = await fetcher<{
     audioFiles: VerseRecitation[];
     pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_hizb/${hizb}`, params);
+  }>(`/recitations/${recitationId}/by_hizb/${hizb}`, params, options?.fetchFn);
 
   return data;
 };
@@ -243,11 +223,11 @@ const findVerseRecitationsByKey = async (
 ) => {
   if (!Utils.isValidVerseKey(key)) throw new Error('Invalid verse key');
 
-  const params = getVerseRecitationsOptions(options);
+  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
   const data = await fetcher<{
     audioFiles: VerseRecitation[];
     pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_ayah/${key}`, params);
+  }>(`/recitations/${recitationId}/by_ayah/${key}`, params, options?.fetchFn);
 
   return data;
 };

package/src/sdk/v4/chapters.ts

@@ -1,20 +1,14 @@
 import { Chapter, ChapterId, ChapterInfo, Language } from '../../types';
-import { fetcher } from './_fetcher';
+import { fetcher, mergeApiOptions } from './_fetcher';
 import Utils from '../utils';
+import { BaseApiOptions } from '../../types/BaseApiOptions';
 
-type GetChapterOptions = Partial<{
-  language: Language;
-}>;
+type GetChapterOptions = Partial<BaseApiOptions>;
 
 const defaultOptions: GetChapterOptions = {
   language: Language.ARABIC,
 };
 
-const getChapterOptions = (options: GetChapterOptions = {}) => {
-  const final: any = { ...defaultOptions, ...options };
-  return final;
-};
-
 /**
  * Get all chapters.
  * @description https://quran.api-docs.io/v4/chapters/list-chapters
@@ -23,10 +17,11 @@ const getChapterOptions = (options: GetChapterOptions = {}) => {
  * quran.v4.chapters.findAll()
  */
 const findAll = async (options?: GetChapterOptions) => {
-  const params = getChapterOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { chapters } = await fetcher<{ chapters: Chapter[] }>(
     '/chapters',
-    params
+    params,
+    options?.fetchFn
   );
 
   return chapters;
@@ -44,10 +39,11 @@ const findAll = async (options?: GetChapterOptions) => {
 const findById = async (id: ChapterId, options?: GetChapterOptions) => {
   if (!Utils.isValidChapterId(id)) throw new Error('Invalid chapter id');
 
-  const params = getChapterOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { chapter } = await fetcher<{ chapter: Chapter }>(
     `/chapters/${id}`,
-    params
+    params,
+    options?.fetchFn
   );
 
   return chapter;
@@ -65,10 +61,11 @@ const findById = async (id: ChapterId, options?: GetChapterOptions) => {
 const findInfoById = async (id: ChapterId, options?: GetChapterOptions) => {
   if (!Utils.isValidChapterId(id)) throw new Error('Invalid chapter id');
 
-  const params = getChapterOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { chapterInfo } = await fetcher<{ chapterInfo: ChapterInfo }>(
     `/chapters/${id}/info`,
-    params
+    params,
+    options?.fetchFn
   );
 
   return chapterInfo;

package/src/sdk/v4/juzs.ts

@@ -1,4 +1,5 @@
 import { Juz } from '../../types';
+import { BaseApiOptions } from '../../types/BaseApiOptions';
 import { fetcher } from './_fetcher';
 
 /**
@@ -7,8 +8,12 @@ import { fetcher } from './_fetcher';
  * @example
  * quran.v4.juzs.findAll()
  */
-const findAll = async () => {
-  const { juzs } = await fetcher<{ juzs: Juz[] }>('/juzs');
+const findAll = async (options?: Omit<BaseApiOptions, 'language'>) => {
+  const { juzs } = await fetcher<{ juzs: Juz[] }>(
+    '/juzs',
+    undefined,
+    options?.fetchFn
+  );
   return juzs;
 };
 

package/src/sdk/v4/resources.ts

@@ -12,21 +12,15 @@ import {
   TranslationResource,
   VerseMediaResource,
 } from '../../types';
-import { fetcher } from './_fetcher';
+import { BaseApiOptions } from '../../types/BaseApiOptions';
+import { fetcher, mergeApiOptions } from './_fetcher';
 
-type GetResourceOptions = Partial<{
-  language: Language;
-}>;
+type GetResourceOptions = Partial<BaseApiOptions>;
 
 const defaultOptions: GetResourceOptions = {
   language: Language.ARABIC,
 };
 
-const getResourcesOptions = (options: GetResourceOptions = {}) => {
-  const final: any = { ...defaultOptions, ...options };
-  return final;
-};
-
 /**
  * Get all recitations.
  * @description https://quran.api-docs.io/v4/resources/recitations
@@ -35,10 +29,10 @@ const getResourcesOptions = (options: GetResourceOptions = {}) => {
  * quran.v4.resources.findAllRecitations()
  */
 const findAllRecitations = async (options?: GetResourceOptions) => {
-  const params = getResourcesOptions(options);
+  const params = mergeApiOptions(options);
   const { recitations } = await fetcher<{
     recitations: RecitationResource[];
-  }>('/resources/recitations', params);
+  }>('/resources/recitations', params, options?.fetchFn);
 
   return recitations;
 };
@@ -53,10 +47,10 @@ const findAllRecitations = async (options?: GetResourceOptions) => {
  * quran.v4.resources.findRecitationInfo('1')
  */
 // const findRecitationInfo = async (id: string, options?: GetResourceOptions) => {
-//   const params = getResourcesOptions(options);
+//   const params = mergeApiOptions(options, defaultOptions);
 //   const { info } = await fetcher<{
 //     info: RecitationInfoResource;
-//   }>(`/resources/recitations/${id}/info`, params);
+//   }>(`/resources/recitations/${id}/info`, params, options?.fetchFn);
 
 //   return info;
 // };
@@ -69,10 +63,10 @@ const findAllRecitations = async (options?: GetResourceOptions) => {
  * quran.v4.resources.findAllTranslations()
  */
 const findAllTranslations = async (options?: GetResourceOptions) => {
-  const params = getResourcesOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { translations } = await fetcher<{
     translations: TranslationResource[];
-  }>('/resources/translations', params);
+  }>('/resources/translations', params, options?.fetchFn);
 
   return translations;
 };
@@ -87,10 +81,10 @@ const findAllTranslations = async (options?: GetResourceOptions) => {
  * quran.v4.resources.findTranslationInfo('169')
  */
 // const findTranslationInfo = async (id: string, options?: GetResourceOptions) => {
-//   const params = getResourcesOptions(options);
+//   const params = mergeApiOptions(options, defaultOptions);
 //   const { info } = await fetcher<{
 //     info: TranslationInfoResource;
-//   }>(`/resources/translations/${id}/info`, params);
+//   }>(`/resources/translations/${id}/info`, params, options?.fetchFn);
 
 //   return info;
 // };
@@ -103,10 +97,10 @@ const findAllTranslations = async (options?: GetResourceOptions) => {
  * quran.v4.resources.findAllTafsirs()
  */
 const findAllTafsirs = async (options?: GetResourceOptions) => {
-  const params = getResourcesOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { tafsirs } = await fetcher<{
     tafsirs: TafsirResource[];
-  }>('/resources/tafsirs', params);
+  }>('/resources/tafsirs', params, options?.fetchFn);
 
   return tafsirs;
 };
@@ -121,10 +115,10 @@ const findAllTafsirs = async (options?: GetResourceOptions) => {
  * quran.v4.resources.findTranslationInfo('1')
  */
 // const findTafsirInfo = async (id: string, options?: GetResourceOptions) => {
-//   const params = getResourcesOptions(options);
+//   const params = mergeApiOptions(options, defaultOptions);
 //   const { info } = await fetcher<{
 //     info: TafsirInfoResource;
-//   }>(`/resources/tafsirs/${id}/info`, params);
+//   }>(`/resources/tafsirs/${id}/info`, params, options?.fetchFn);
 
 //   return info;
 // };
@@ -135,10 +129,12 @@ const findAllTafsirs = async (options?: GetResourceOptions) => {
  * @example
  * quran.v4.resources.findAllRecitationStyles()
  */
-const findAllRecitationStyles = async () => {
+const findAllRecitationStyles = async (
+  options?: Omit<BaseApiOptions, 'language'>
+) => {
   const { recitationStyles } = await fetcher<{
     recitationStyles: RecitationStylesResource;
-  }>('/resources/recitation_styles');
+  }>('/resources/recitation_styles', undefined, options?.fetchFn);
 
   return recitationStyles;
 };
@@ -151,10 +147,10 @@ const findAllRecitationStyles = async () => {
  * quran.v4.resources.findAllLanguages()
  */
 const findAllLanguages = async (options?: GetResourceOptions) => {
-  const params = getResourcesOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { languages } = await fetcher<{
     languages: LanguageResource[];
-  }>('/resources/languages', params);
+  }>('/resources/languages', params, options?.fetchFn);
 
   return languages;
 };
@@ -167,10 +163,10 @@ const findAllLanguages = async (options?: GetResourceOptions) => {
  * quran.v4.resources.findAllChapterInfos()
  */
 const findAllChapterInfos = async (options?: GetResourceOptions) => {
-  const params = getResourcesOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { chapterInfos } = await fetcher<{
     chapterInfos: ChapterInfoResource[];
-  }>('/resources/chapter_infos', params);
+  }>('/resources/chapter_infos', params, options?.fetchFn);
 
   return chapterInfos;
 };
@@ -183,10 +179,10 @@ const findAllChapterInfos = async (options?: GetResourceOptions) => {
  * quran.v4.resources.findVerseMedia()
  */
 const findVerseMedia = async (options?: GetResourceOptions) => {
-  const params = getResourcesOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { verseMedia } = await fetcher<{
     verseMedia: VerseMediaResource;
-  }>(`/resources/verse_media`, params);
+  }>(`/resources/verse_media`, params, options?.fetchFn);
 
   return verseMedia;
 };
@@ -199,10 +195,10 @@ const findVerseMedia = async (options?: GetResourceOptions) => {
  * quran.v4.resources.findAllChapterReciters()
  */
 const findAllChapterReciters = async (options?: GetResourceOptions) => {
-  const params = getResourcesOptions(options);
+  const params = mergeApiOptions(options, defaultOptions);
   const { reciters } = await fetcher<{
     reciters: ChapterReciterResource[];
-  }>(`/resources/chapter_reciters`, params);
+  }>(`/resources/chapter_reciters`, params, options?.fetchFn);
 
   return reciters;
 };

package/src/sdk/v4/search.ts

@@ -1,22 +1,19 @@
 import { Language, SearchResponse } from '../../types';
-import { fetcher } from './_fetcher';
+import { BaseApiOptions } from '../../types/BaseApiOptions';
+import { fetcher, mergeApiOptions } from './_fetcher';
 
-type SearchOptions = Partial<{
-  language: Language;
-  size: number;
-  page: number;
-}>;
+type SearchOptions = Partial<
+  BaseApiOptions & {
+    size: number;
+    page: number;
+  }
+>;
 
 const defaultSearchOptions: SearchOptions = {
   language: Language.ARABIC,
   size: 30,
 };
 
-const getSearchOptions = (q: string, options: SearchOptions = {}) => {
-  const all = { ...defaultSearchOptions, ...options, q };
-  return all;
-};
-
 /**
  * Search
  * @description https://quran.api-docs.io/v4/search/KfCmk4KQYbtyK9adj
@@ -29,8 +26,12 @@ const getSearchOptions = (q: string, options: SearchOptions = {}) => {
  * quran.v4.search.search('نور', { language: Language.ENGLISH, page: 2 })
  */
 const search = async (q: string, options?: SearchOptions) => {
-  const params = getSearchOptions(q, options);
-  const { search } = await fetcher<SearchResponse>('/search', params);
+  const params = mergeApiOptions({ q, ...options }, defaultSearchOptions);
+  const { search } = await fetcher<SearchResponse>(
+    '/search',
+    params,
+    options?.fetchFn
+  );
 
   return search;
 };