@quranjs/api 1.7.1 → 1.7.3

package/src/sdk/v4/audio.ts

@@ -1,246 +0,0 @@
-import {
-  ChapterRecitation,
-  VerseRecitation,
-  ChapterId,
-  HizbNumber,
-  JuzNumber,
-  Language,
-  PageNumber,
-  Pagination,
-  RubNumber,
-  VerseKey,
-  VerseRecitationField,
-} from '../../types';
-import Utils from '../utils';
-import { fetcher, mergeApiOptions } from './_fetcher';
-import { BaseApiOptions } from '../../types/BaseApiOptions';
-
-type GetChapterRecitationOptions = Partial<BaseApiOptions>;
-
-const defaultChapterRecitationsOptions: GetChapterRecitationOptions = {
-  language: Language.ARABIC,
-};
-
-type GetVerseRecitationOptions = Partial<
-  BaseApiOptions & {
-    fields: Partial<Record<VerseRecitationField, boolean>>;
-  }
->;
-
-const defaultVerseRecitationsOptions: GetVerseRecitationOptions = {
-  language: Language.ARABIC,
-};
-
-/**
- * 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
- * @param {string} reciterId
- * @param {GetChapterRecitationOptions} options
- * @example
- * quran.v4.audio.findAllChapterRecitations('2')
- */
-const findAllChapterRecitations = async (
-  reciterId: string,
-  options?: GetChapterRecitationOptions
-) => {
-  const params = mergeApiOptions(options, defaultChapterRecitationsOptions);
-  const { audioFiles } = await fetcher<{ audioFiles: ChapterRecitation[] }>(
-    `/chapter_recitations/${reciterId}`,
-    params,
-    options?.fetchFn
-  );
-  return audioFiles;
-};
-
-/**
- * Get chapter recitation for specific reciter and a specific chapter
- * @description https://quran.api-docs.io/v4/audio-recitations/get-single-surah-audio-for-specific-reciter
- * @param {ChapterId} chapterId
- * @param {string} reciterId
- * @param {GetChapterRecitationOptions} options
- * @example
- * quran.v4.audio.findChapterRecitationById('1', '2') // first chapter recitation for reciter 2
- */
-const findChapterRecitationById = async (
-  chapterId: ChapterId,
-  reciterId: string,
-  options?: GetChapterRecitationOptions
-) => {
-  if (!Utils.isValidChapterId(chapterId)) throw new Error('Invalid chapter id');
-
-  const params = mergeApiOptions(options, defaultChapterRecitationsOptions);
-  const { audioFile } = await fetcher<{ audioFile: ChapterRecitation }>(
-    `/chapter_recitations/${reciterId}/${chapterId}`,
-    params,
-    options?.fetchFn
-  );
-
-  return audioFile;
-};
-
-/**
- * Get all verse audio files for a specific reciter and a specific chapter
- * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-surah
- * @param {ChapterId} chapterId
- * @param {string} recitationId
- * @param {GetVerseRecitationOptions} options
- * @example
- * quran.v4.audio.findVerseRecitationsByChapter('1', '2')
- */
-const findVerseRecitationsByChapter = async (
-  chapterId: ChapterId,
-  recitationId: string,
-  options?: GetVerseRecitationOptions
-) => {
-  if (!Utils.isValidChapterId(chapterId)) throw new Error('Invalid chapter id');
-
-  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
-  const data = await fetcher<{
-    audioFiles: VerseRecitation[];
-    pagination: Pagination;
-  }>(
-    `/recitations/${recitationId}/by_chapter/${chapterId}`,
-    params,
-    options?.fetchFn
-  );
-
-  return data;
-};
-
-/**
- * Get all verse audio files for a specific reciter and a specific juz
- * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-juz
- * @param {JuzNumber} juz
- * @param {string} recitationId
- * @param {GetRecitationsOptions} options
- * @example
- * quran.v4.audio.findVerseRecitationsByJuz('1', '2')
- */
-const findVerseRecitationsByJuz = async (
-  juz: JuzNumber,
-  recitationId: string,
-  options?: GetVerseRecitationOptions
-) => {
-  if (!Utils.isValidJuz(juz)) throw new Error('Invalid juz');
-
-  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
-  const data = await fetcher<{
-    audioFiles: VerseRecitation[];
-    pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_juz/${juz}`, params, options?.fetchFn);
-
-  return data;
-};
-
-/**
- * Get all verse audio files for a specific reciter and a specific mushaf page
- * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-madani-mushaf-page
- * @param {PageNumber} page
- * @param {string} recitationId
- * @param {GetVerseRecitationOptions} options
- * @example
- * quran.v4.audio.findVerseRecitationsByPage('1', '2')
- */
-const findVerseRecitationsByPage = async (
-  page: PageNumber,
-  recitationId: string,
-  options?: GetVerseRecitationOptions
-) => {
-  if (!Utils.isValidQuranPage(page)) throw new Error('Invalid page');
-
-  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
-  const data = await fetcher<{
-    audioFiles: VerseRecitation[];
-    pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_page/${page}`, params, options?.fetchFn);
-
-  return data;
-};
-
-/**
- * Get all verse audio files for a specific reciter and a specific rub
- * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-rub
- * @param {RubNumber} rub
- * @param {string} recitationId
- * @param {GetVerseRecitationOptions} options
- * @example
- * quran.v4.audio.findVerseRecitationsByRub('1', '2')
- */
-const findVerseRecitationsByRub = async (
-  rub: RubNumber,
-  recitationId: string,
-  options?: GetVerseRecitationOptions
-) => {
-  if (!Utils.isValidRub(rub)) throw new Error('Invalid rub');
-
-  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
-  const data = await fetcher<{
-    audioFiles: VerseRecitation[];
-    pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_rub/${rub}`, params, options?.fetchFn);
-
-  return data;
-};
-
-/**
- * Get all verse audio files for a specific reciter and a specific hizb
- * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-hizb
- * @param {HizbNumber} hizb
- * @param {string} recitationId
- * @param {GetVerseRecitationOptions} options
- * @example
- * quran.v4.audio.findVerseRecitationsByHizb('1', '2')
- */
-const findVerseRecitationsByHizb = async (
-  hizb: HizbNumber,
-  recitationId: string,
-  options?: GetVerseRecitationOptions
-) => {
-  if (!Utils.isValidHizb(hizb)) throw new Error('Invalid hizb');
-
-  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
-  const data = await fetcher<{
-    audioFiles: VerseRecitation[];
-    pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_hizb/${hizb}`, params, options?.fetchFn);
-
-  return data;
-};
-
-/**
- * Get all verse audio files for a specific reciter and a specific verse
- * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-ayah
- * @param {VerseKey} key
- * @param {string} recitationId
- * @param {GetVerseRecitationOptions} options
- * @example
- * quran.v4.audio.findVerseRecitationsByKey('1:1', '2')
- */
-const findVerseRecitationsByKey = async (
-  key: VerseKey,
-  recitationId: string,
-  options?: GetVerseRecitationOptions
-) => {
-  if (!Utils.isValidVerseKey(key)) throw new Error('Invalid verse key');
-
-  const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
-  const data = await fetcher<{
-    audioFiles: VerseRecitation[];
-    pagination: Pagination;
-  }>(`/recitations/${recitationId}/by_ayah/${key}`, params, options?.fetchFn);
-
-  return data;
-};
-
-const audio = {
-  findAllChapterRecitations,
-  findChapterRecitationById,
-  findVerseRecitationsByChapter,
-  findVerseRecitationsByJuz,
-  findVerseRecitationsByPage,
-  findVerseRecitationsByRub,
-  findVerseRecitationsByHizb,
-  findVerseRecitationsByKey,
-};
-
-export default audio;

package/src/sdk/v4/chapters.ts

@@ -1,80 +0,0 @@
-import { Chapter, ChapterId, ChapterInfo, Language } from '../../types';
-import { fetcher, mergeApiOptions } from './_fetcher';
-import Utils from '../utils';
-import { BaseApiOptions } from '../../types/BaseApiOptions';
-
-type GetChapterOptions = Partial<BaseApiOptions>;
-
-const defaultOptions: GetChapterOptions = {
-  language: Language.ARABIC,
-};
-
-/**
- * Get all chapters.
- * @description https://quran.api-docs.io/v4/chapters/list-chapters
- * @param {GetChapterOptions} options
- * @example
- * quran.v4.chapters.findAll()
- */
-const findAll = async (options?: GetChapterOptions) => {
-  const params = mergeApiOptions(options, defaultOptions);
-  const { chapters } = await fetcher<{ chapters: Chapter[] }>(
-    '/chapters',
-    params,
-    options?.fetchFn
-  );
-
-  return chapters;
-};
-
-/**
- * Get chapter by id.
- * @description https://quran.api-docs.io/v4/chapters/get-chapter
- * @param {ChapterId} id chapter id, minimum 1, maximum 114
- * @param {GetChapterOptions} options
- * @example
- * quran.v4.chapters.findById('1')
- * quran.v4.chapters.findById('114')
- */
-const findById = async (id: ChapterId, options?: GetChapterOptions) => {
-  if (!Utils.isValidChapterId(id)) throw new Error('Invalid chapter id');
-
-  const params = mergeApiOptions(options, defaultOptions);
-  const { chapter } = await fetcher<{ chapter: Chapter }>(
-    `/chapters/${id}`,
-    params,
-    options?.fetchFn
-  );
-
-  return chapter;
-};
-
-/**
- * Get chapter info by id.
- * @description https://quran.api-docs.io/v4/chapters/chapter_info
- * @param {ChapterId} id chapter id, minimum 1, maximum 114
- * @param {GetChapterOptions} options
- * @example
- * quran.v4.chapters.findInfoById('1')
- * quran.v4.chapters.findInfoById('114')
- */
-const findInfoById = async (id: ChapterId, options?: GetChapterOptions) => {
-  if (!Utils.isValidChapterId(id)) throw new Error('Invalid chapter id');
-
-  const params = mergeApiOptions(options, defaultOptions);
-  const { chapterInfo } = await fetcher<{ chapterInfo: ChapterInfo }>(
-    `/chapters/${id}/info`,
-    params,
-    options?.fetchFn
-  );
-
-  return chapterInfo;
-};
-
-const chapters = {
-  findAll,
-  findById,
-  findInfoById,
-};
-
-export default chapters;

package/src/sdk/v4/index.ts

@@ -1,17 +0,0 @@
-import chapters from './chapters';
-import verses from './verses';
-import juzs from './juzs';
-import audio from './audio';
-import resources from './resources';
-import search from './search';
-
-const v4 = {
-  chapters,
-  verses,
-  juzs,
-  audio,
-  resources,
-  search,
-};
-
-export default v4;

package/src/sdk/v4/juzs.ts

@@ -1,22 +0,0 @@
-import { Juz } from '../../types';
-import { BaseApiOptions } from '../../types/BaseApiOptions';
-import { fetcher } from './_fetcher';
-
-/**
- * Get All Juzs
- * @description https://quran.api-docs.io/v4/juz/get-all-juzs
- * @example
- * quran.v4.juzs.findAll()
- */
-const findAll = async (options?: Omit<BaseApiOptions, 'language'>) => {
-  const { juzs } = await fetcher<{ juzs: Juz[] }>(
-    '/juzs',
-    undefined,
-    options?.fetchFn
-  );
-  return juzs;
-};
-
-const juzs = { findAll };
-
-export default juzs;

package/src/sdk/v4/resources.ts

@@ -1,220 +0,0 @@
-import {
-  ChapterInfoResource,
-  ChapterReciterResource,
-  Language,
-  LanguageResource,
-  // RecitationInfoResource,
-  RecitationResource,
-  RecitationStylesResource,
-  // TafsirInfoResource,
-  TafsirResource,
-  // TranslationInfoResource,
-  TranslationResource,
-  VerseMediaResource,
-} from '../../types';
-import { BaseApiOptions } from '../../types/BaseApiOptions';
-import { fetcher, mergeApiOptions } from './_fetcher';
-
-type GetResourceOptions = Partial<BaseApiOptions>;
-
-const defaultOptions: GetResourceOptions = {
-  language: Language.ARABIC,
-};
-
-/**
- * Get all recitations.
- * @description https://quran.api-docs.io/v4/resources/recitations
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findAllRecitations()
- */
-const findAllRecitations = async (options?: GetResourceOptions) => {
-  const params = mergeApiOptions(options);
-  const { recitations } = await fetcher<{
-    recitations: RecitationResource[];
-  }>('/resources/recitations', params, options?.fetchFn);
-
-  return recitations;
-};
-
-// TODO: uncomment when API is ready
-/**
- * Get all recitation info.
- * @description https://quran.api-docs.io/v4/resources/recitation-info
- * @param {string} id recitation id
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findRecitationInfo('1')
- */
-// const findRecitationInfo = async (id: string, options?: GetResourceOptions) => {
-//   const params = mergeApiOptions(options, defaultOptions);
-//   const { info } = await fetcher<{
-//     info: RecitationInfoResource;
-//   }>(`/resources/recitations/${id}/info`, params, options?.fetchFn);
-
-//   return info;
-// };
-
-/**
- * Get all translations.
- * @description https://quran.api-docs.io/v4/resources/translations
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findAllTranslations()
- */
-const findAllTranslations = async (options?: GetResourceOptions) => {
-  const params = mergeApiOptions(options, defaultOptions);
-  const { translations } = await fetcher<{
-    translations: TranslationResource[];
-  }>('/resources/translations', params, options?.fetchFn);
-
-  return translations;
-};
-
-// TODO: uncomment when API is ready
-/**
- * Get translation info.
- * @description https://quran.api-docs.io/v4/resources/translation-info
- * @param {string} id translation id
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findTranslationInfo('169')
- */
-// const findTranslationInfo = async (id: string, options?: GetResourceOptions) => {
-//   const params = mergeApiOptions(options, defaultOptions);
-//   const { info } = await fetcher<{
-//     info: TranslationInfoResource;
-//   }>(`/resources/translations/${id}/info`, params, options?.fetchFn);
-
-//   return info;
-// };
-
-/**
- * Get all tafsirs.
- * @description https://quran.api-docs.io/v4/resources/tafsirs
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findAllTafsirs()
- */
-const findAllTafsirs = async (options?: GetResourceOptions) => {
-  const params = mergeApiOptions(options, defaultOptions);
-  const { tafsirs } = await fetcher<{
-    tafsirs: TafsirResource[];
-  }>('/resources/tafsirs', params, options?.fetchFn);
-
-  return tafsirs;
-};
-
-// TODO: uncomment when API is ready
-/**
- * Get tafsir info.
- * @description https://quran.api-docs.io/v4/resources/tafsirs-info
- * @param {string} id tafsir id
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findTranslationInfo('1')
- */
-// const findTafsirInfo = async (id: string, options?: GetResourceOptions) => {
-//   const params = mergeApiOptions(options, defaultOptions);
-//   const { info } = await fetcher<{
-//     info: TafsirInfoResource;
-//   }>(`/resources/tafsirs/${id}/info`, params, options?.fetchFn);
-
-//   return info;
-// };
-
-/**
- * Get all recitation styles.
- * @description https://quran.api-docs.io/v4/resources/recitation-styles
- * @example
- * quran.v4.resources.findAllRecitationStyles()
- */
-const findAllRecitationStyles = async (
-  options?: Omit<BaseApiOptions, 'language'>
-) => {
-  const { recitationStyles } = await fetcher<{
-    recitationStyles: RecitationStylesResource;
-  }>('/resources/recitation_styles', undefined, options?.fetchFn);
-
-  return recitationStyles;
-};
-
-/**
- * Get all languages.
- * @description https://quran.api-docs.io/v4/resources/languages
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findAllLanguages()
- */
-const findAllLanguages = async (options?: GetResourceOptions) => {
-  const params = mergeApiOptions(options, defaultOptions);
-  const { languages } = await fetcher<{
-    languages: LanguageResource[];
-  }>('/resources/languages', params, options?.fetchFn);
-
-  return languages;
-};
-
-/**
- * Get all chapter infos.
- * @description https://quran.api-docs.io/v4/resources/chapter-info
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findAllChapterInfos()
- */
-const findAllChapterInfos = async (options?: GetResourceOptions) => {
-  const params = mergeApiOptions(options, defaultOptions);
-  const { chapterInfos } = await fetcher<{
-    chapterInfos: ChapterInfoResource[];
-  }>('/resources/chapter_infos', params, options?.fetchFn);
-
-  return chapterInfos;
-};
-
-/**
- * Get verse media.
- * @description https://quran.api-docs.io/v4/resources/verse_media
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findVerseMedia()
- */
-const findVerseMedia = async (options?: GetResourceOptions) => {
-  const params = mergeApiOptions(options, defaultOptions);
-  const { verseMedia } = await fetcher<{
-    verseMedia: VerseMediaResource;
-  }>(`/resources/verse_media`, params, options?.fetchFn);
-
-  return verseMedia;
-};
-
-/**
- * Get all chapter reciters.
- * @description https://quran.api-docs.io/v4/resources/list-of-chapter-reciters
- * @param {GetResourceOptions} options
- * @example
- * quran.v4.resources.findAllChapterReciters()
- */
-const findAllChapterReciters = async (options?: GetResourceOptions) => {
-  const params = mergeApiOptions(options, defaultOptions);
-  const { reciters } = await fetcher<{
-    reciters: ChapterReciterResource[];
-  }>(`/resources/chapter_reciters`, params, options?.fetchFn);
-
-  return reciters;
-};
-
-const resources = {
-  findAllRecitations,
-  findAllTranslations,
-  findAllTafsirs,
-  findAllRecitationStyles,
-  findAllLanguages,
-  findVerseMedia,
-  findAllChapterReciters,
-  findAllChapterInfos,
-  // findRecitationInfo
-  // findTranslationInfo
-  // findTafsirInfo
-};
-
-export default resources;

package/src/sdk/v4/search.ts

@@ -1,41 +0,0 @@
-import { Language, SearchResponse } from '../../types';
-import { BaseApiOptions } from '../../types/BaseApiOptions';
-import { fetcher, mergeApiOptions } from './_fetcher';
-
-type SearchOptions = Partial<
-  BaseApiOptions & {
-    size: number;
-    page: number;
-  }
->;
-
-const defaultSearchOptions: SearchOptions = {
-  language: Language.ARABIC,
-  size: 30,
-};
-
-/**
- * Search
- * @description https://quran.api-docs.io/v4/search/KfCmk4KQYbtyK9adj
- * @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 })
- */
-const search = async (q: string, options?: SearchOptions) => {
-  const params = mergeApiOptions({ q, ...options }, defaultSearchOptions);
-  const { search } = await fetcher<SearchResponse>(
-    '/search',
-    params,
-    options?.fetchFn
-  );
-
-  return search;
-};
-
-const searchApi = { search };
-
-export default searchApi;