fix: update qdc docs url in jsdoc & bring back commentted apis

quran · Jan 7, 2025 · d8e0db9 · d8e0db9
1 parent 818682c
commit d8e0db9
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 73 deletions.
diff --git a/src/sdk/v4/audio.ts b/src/sdk/v4/audio.ts
@@ -33,7 +33,7 @@ const defaultVerseRecitationsOptions: GetVerseRecitationOptions = {
 
 /**
  * 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
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/chapter-reciter-audio-files
  * @param {string} reciterId
  * @param {GetChapterRecitationOptions} options
  * @example
@@ -54,7 +54,7 @@ const findAllChapterRecitations = async (
 
 /**
  * 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
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/chapter-reciter-audio-file
  * @param {ChapterId} chapterId
  * @param {string} reciterId
  * @param {GetChapterRecitationOptions} options
@@ -80,7 +80,7 @@ const findChapterRecitationById = async (
 
 /**
  * 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
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-surah-recitation
  * @param {ChapterId} chapterId
  * @param {string} recitationId
  * @param {GetVerseRecitationOptions} options
@@ -109,7 +109,7 @@ const findVerseRecitationsByChapter = async (
 
 /**
  * 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
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-juz-recitaiton
  * @param {JuzNumber} juz
  * @param {string} recitationId
  * @param {GetRecitationsOptions} options
@@ -134,7 +134,7 @@ const findVerseRecitationsByJuz = async (
 
 /**
  * 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
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-page-recitaiton
  * @param {PageNumber} page
  * @param {string} recitationId
  * @param {GetVerseRecitationOptions} options
@@ -159,7 +159,7 @@ const findVerseRecitationsByPage = async (
 
 /**
  * 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
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-rub-el-hizb-recitaiton
  * @param {RubNumber} rub
  * @param {string} recitationId
  * @param {GetVerseRecitationOptions} options
@@ -184,7 +184,7 @@ const findVerseRecitationsByRub = async (
 
 /**
  * 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
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-hizb-recitaiton
  * @param {HizbNumber} hizb
  * @param {string} recitationId
  * @param {GetVerseRecitationOptions} options
@@ -209,7 +209,7 @@ const findVerseRecitationsByHizb = async (
 
 /**
  * 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
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-ayah-recitaiton
  * @param {VerseKey} key
  * @param {string} recitationId
  * @param {GetVerseRecitationOptions} options

diff --git a/src/sdk/v4/chapters.ts b/src/sdk/v4/chapters.ts
@@ -11,7 +11,7 @@ const defaultOptions: GetChapterOptions = {
 
 /**
  * Get all chapters.
- * @description https://quran.api-docs.io/v4/chapters/list-chapters
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-chapters
  * @param {GetChapterOptions} options
  * @example
  * quran.v4.chapters.findAll()
@@ -29,7 +29,7 @@ const findAll = async (options?: GetChapterOptions) => {
 
 /**
  * Get chapter by id.
- * @description https://quran.api-docs.io/v4/chapters/get-chapter
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/get-chapter
  * @param {ChapterId} id chapter id, minimum 1, maximum 114
  * @param {GetChapterOptions} options
  * @example
@@ -51,7 +51,7 @@ const findById = async (id: ChapterId, options?: GetChapterOptions) => {
 
 /**
  * Get chapter info by id.
- * @description https://quran.api-docs.io/v4/chapters/chapter_info
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/info
  * @param {ChapterId} id chapter id, minimum 1, maximum 114
  * @param {GetChapterOptions} options
  * @example

diff --git a/src/sdk/v4/juzs.ts b/src/sdk/v4/juzs.ts
@@ -4,7 +4,7 @@ import { fetcher } from './_fetcher';
 
 /**
  * Get All Juzs
- * @description https://quran.api-docs.io/v4/juz/get-all-juzs
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/juzs
  * @example
  * quran.v4.juzs.findAll()
  */

diff --git a/src/sdk/v4/resources.ts b/src/sdk/v4/resources.ts
@@ -3,12 +3,12 @@ import {
   ChapterReciterResource,
   Language,
   LanguageResource,
-  // RecitationInfoResource,
+  RecitationInfoResource,
   RecitationResource,
   RecitationStylesResource,
-  // TafsirInfoResource,
+  TafsirInfoResource,
   TafsirResource,
-  // TranslationInfoResource,
+  TranslationInfoResource,
   TranslationResource,
   VerseMediaResource,
 } from '../../types';
@@ -23,7 +23,7 @@ const defaultOptions: GetResourceOptions = {
 
 /**
  * Get all recitations.
- * @description https://quran.api-docs.io/v4/resources/recitations
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/recitations
  * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllRecitations()
@@ -37,27 +37,26 @@ const findAllRecitations = async (options?: GetResourceOptions) => {
   return recitations;
 };
 
-// TODO: uncomment when API is ready
 /**
  * Get all recitation info.
- * @description https://quran.api-docs.io/v4/resources/recitation-info
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/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);
+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;
-// };
+  return info;
+};
 
 /**
  * Get all translations.
- * @description https://quran.api-docs.io/v4/resources/translations
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/translations
  * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllTranslations()
@@ -71,27 +70,29 @@ const findAllTranslations = async (options?: GetResourceOptions) => {
   return translations;
 };
 
-// TODO: uncomment when API is ready
 /**
  * Get translation info.
- * @description https://quran.api-docs.io/v4/resources/translation-info
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/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);
+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;
-// };
+  return info;
+};
 
 /**
  * Get all tafsirs.
- * @description https://quran.api-docs.io/v4/resources/tafsirs
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/tafsirs
  * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllTafsirs()
@@ -105,27 +106,26 @@ const findAllTafsirs = async (options?: GetResourceOptions) => {
   return tafsirs;
 };
 
-// TODO: uncomment when API is ready
 /**
  * Get tafsir info.
- * @description https://quran.api-docs.io/v4/resources/tafsirs-info
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/tafsir-info
  * @param {string} id tafsir id
  * @param {GetResourceOptions} options
  * @example
- * quran.v4.resources.findTranslationInfo('1')
+ * quran.v4.resources.findTafsirInfo('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);
+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;
-// };
+  return info;
+};
 
 /**
  * Get all recitation styles.
- * @description https://quran.api-docs.io/v4/resources/recitation-styles
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/recitation-styles
  * @example
  * quran.v4.resources.findAllRecitationStyles()
  */
@@ -141,7 +141,7 @@ const findAllRecitationStyles = async (
 
 /**
  * Get all languages.
- * @description https://quran.api-docs.io/v4/resources/languages
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/languages
  * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllLanguages()
@@ -157,7 +157,7 @@ const findAllLanguages = async (options?: GetResourceOptions) => {
 
 /**
  * Get all chapter infos.
- * @description https://quran.api-docs.io/v4/resources/chapter-info
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/chapter-info
  * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllChapterInfos()
@@ -173,7 +173,7 @@ const findAllChapterInfos = async (options?: GetResourceOptions) => {
 
 /**
  * Get verse media.
- * @description https://quran.api-docs.io/v4/resources/verse_media
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/verse-media
  * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findVerseMedia()
@@ -189,7 +189,7 @@ const findVerseMedia = async (options?: GetResourceOptions) => {
 
 /**
  * Get all chapter reciters.
- * @description https://quran.api-docs.io/v4/resources/list-of-chapter-reciters
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/chapter-reciters
  * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllChapterReciters()
@@ -212,9 +212,9 @@ const resources = {
   findVerseMedia,
   findAllChapterReciters,
   findAllChapterInfos,
-  // findRecitationInfo
-  // findTranslationInfo
-  // findTafsirInfo
+  findRecitationInfo,
+  findTranslationInfo,
+  findTafsirInfo,
 };
 
 export default resources;
diff --git a/src/sdk/v4/search.ts b/src/sdk/v4/search.ts
@@ -16,7 +16,7 @@ const defaultSearchOptions: SearchOptions = {
 
 /**
  * Search
- * @description https://quran.api-docs.io/v4/search/KfCmk4KQYbtyK9adj
+ * @description https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/search
  * @param {string} q search query
  * @param {SearchOptions} options
  * @example