@quranjs/api 1.1.4 → 1.4.0

package/dist/api.esm.js

@@ -1,8 +1,5 @@
-import { Language as Language$1 } from '@/types';
 import fetch from 'cross-fetch';
 import { camelizeKeys, decamelizeKeys, decamelize } from 'humps';
-import stringify from '@/utils/qs-stringify';
-import { removeBeginningSlash } from '@/utils/misc';
 
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
   try {
@@ -818,6 +815,199 @@ try {
 
 var _regeneratorRuntime = runtime.exports;
 
+var CharType;
+
+(function (CharType) {
+  CharType["Word"] = "word";
+  CharType["End"] = "end";
+  CharType["Pause"] = "pause";
+  CharType["Sajdah"] = "sajdah";
+  CharType["RubElHizb"] = "rub-el-hizb";
+})(CharType || (CharType = {}));
+
+var Language;
+
+(function (Language) {
+  Language["ARABIC"] = "ar";
+  Language["ENGLISH"] = "en";
+  Language["URDU"] = "ur";
+  Language["BENGALI"] = "bn";
+  Language["TURKISH"] = "tr";
+  Language["SPANISH"] = "es";
+  Language["GERMAN"] = "de";
+  Language["BOSNIAN"] = "bs";
+  Language["RUSSIAN"] = "ru";
+  Language["ALBANIAN_AL"] = "al";
+  Language["FRENCH"] = "fr";
+  Language["DUTCH"] = "nl";
+  Language["TAMIL"] = "ta";
+  Language["TAJIK"] = "tg";
+  Language["INDONESIAN"] = "id";
+  Language["UZBEK"] = "uz";
+  Language["VIETNAMESE"] = "vi";
+  Language["CHINESE"] = "zh";
+  Language["ITALIAN"] = "it";
+  Language["JAPANESE"] = "ja";
+  Language["MALAYALAM"] = "ml";
+  Language["AMHARIC"] = "am";
+  Language["KAZAKH"] = "kk";
+  Language["PORTUGUESE"] = "pt";
+  Language["TAGALOG"] = "tl";
+  Language["THAI"] = "th";
+  Language["KOREAN"] = "ko";
+  Language["HINDI"] = "hi";
+  Language["KURDISH"] = "ku";
+  Language["HAUSA"] = "ha";
+  Language["AZERI"] = "az";
+  Language["SWAHILI"] = "sw";
+  Language["PERSIAN"] = "fa";
+  Language["SERBIAN"] = "sr";
+  Language["MARANAO"] = "mrn";
+  Language["AMAZIGH"] = "zgh";
+  Language["ASSAMESE"] = "as";
+  Language["BULGARIAN"] = "bg";
+  Language["CHECHEN"] = "ce";
+  Language["CZECH"] = "cs";
+  Language["DIVEHI"] = "dv";
+  Language["DHIVEHI"] = "dv";
+  Language["MALDIVIAN"] = "dv";
+  Language["FINNISH"] = "fi";
+  Language["GUJAARATI"] = "gu";
+  Language["HEBREW"] = "he";
+  Language["GEORGIAN"] = "ka";
+  Language["CENTRAL_KHMER"] = "km";
+  Language["GANDA"] = "lg";
+  Language["MARATHI"] = "mr";
+  Language["YORUBA"] = "yo";
+  Language["MALAY"] = "ms";
+  Language["NEPALI"] = "ne";
+  Language["SWEDISH"] = "sv";
+  Language["TELUGU"] = "te";
+  Language["TATAR"] = "tt";
+  Language["UIGHUR"] = "ug";
+  Language["UYGHUR"] = "ug";
+  Language["UKRAINIAN"] = "uk";
+  Language["NORWEGIAN"] = "no";
+  Language["OROMO"] = "om";
+  Language["POLISH"] = "pl";
+  Language["PASHTO"] = "ps";
+  Language["ROMANIAN"] = "ro";
+  Language["SINDHI"] = "sd";
+  Language["NORTHERN_SAMI"] = "se";
+  Language["SINHALA"] = "si";
+  Language["SINHALESE"] = "si";
+  Language["SOMALI"] = "so";
+  Language["ALBANIAN_SQ"] = "sq";
+})(Language || (Language = {}));
+
+var QuranFont;
+
+(function (QuranFont) {
+  QuranFont["MadaniV1"] = "code_v1";
+  QuranFont["MadaniV2"] = "code_v2";
+  QuranFont["Uthmani"] = "text_uthmani";
+})(QuranFont || (QuranFont = {}));
+
+// Reference: https://github.com/billjs/query-string/blob/master/src/index.ts
+var defaultStringifyFunction = function defaultStringifyFunction(_key, value) {
+  return value;
+};
+
+var defaultEq = '=';
+var defaultSep = '&';
+var defaultConfig = {
+  eq: defaultEq,
+  sep: defaultSep,
+  prefix: '',
+  fn: defaultStringifyFunction
+};
+/**
+ * Given a query object, return the query string
+ * See qs-stringify.test.ts for examples
+ *
+ * @param {QueryObject} obj a query object to be converted to a query string
+ * @param {Config} config optional configuration
+ * @returns {string} query string
+ *
+ * @example
+ * stringify({a: 1, b: 2}) // returns 'a=1&b=s'
+ */
+
+function stringify(obj, config) {
+  if (config === void 0) {
+    config = defaultConfig;
+  }
+
+  var _defaultConfig$config = _extends({}, defaultConfig, config),
+      eq = _defaultConfig$config.eq,
+      sep = _defaultConfig$config.sep,
+      fn = _defaultConfig$config.fn,
+      prefix = _defaultConfig$config.prefix;
+
+  if (obj == null || !isObject(obj)) {
+    return '';
+  }
+
+  return Object.entries(obj).filter(function (_ref) {
+    var value = _ref[1];
+    return value !== null;
+  }) // filter out null values
+  .map(function (_ref2) {
+    var key = _ref2[0],
+        value = _ref2[1];
+    if (Array.isArray(value)) return encode(key, value.join(','), {
+      eq: eq,
+      fn: fn,
+      prefix: prefix
+    });
+    if (isObject(value)) return stringify(value, {
+      eq: eq,
+      sep: sep,
+      fn: fn,
+      prefix: getKey(key, prefix)
+    });
+    return encode(key, value, {
+      eq: eq,
+      fn: fn,
+      prefix: prefix
+    });
+  }).join(sep);
+} // encode the key and add prefix if necessary
+
+
+var getKey = function getKey(key, prefix) {
+  if (prefix === void 0) {
+    prefix = '';
+  }
+
+  var encodedKey = encodeURIComponent(key);
+  if (prefix) return prefix + "[" + encodedKey + "]";
+  return encodedKey;
+}; // encode the key and value of a query object
+
+
+var encode = function encode(key, value, _ref3) {
+  var _ref3$eq = _ref3.eq,
+      eq = _ref3$eq === void 0 ? defaultEq : _ref3$eq,
+      _ref3$fn = _ref3.fn,
+      fn = _ref3$fn === void 0 ? defaultStringifyFunction : _ref3$fn,
+      _ref3$prefix = _ref3.prefix,
+      prefix = _ref3$prefix === void 0 ? '' : _ref3$prefix;
+  var newValue = encodeURIComponent(fn(key, value));
+  var newKey = getKey(key, prefix);
+  return [newKey, newValue].join(eq);
+}; // check if the given value is an object
+
+
+function isObject(obj) {
+  var type = typeof obj;
+  return obj && (type === 'object' || type === 'function') || false;
+}
+
+var removeBeginningSlash = function removeBeginningSlash(url) {
+  return url.startsWith('/') ? url.slice(1) : url;
+};
+
 var API_BASE_URL = 'https://api.quran.com/api/v4/';
 var makeUrl = function makeUrl(url, params) {
   var baseUrl = "" + API_BASE_URL + removeBeginningSlash(url);
@@ -1107,7 +1297,7 @@ var Utils = {
 };
 
 var defaultOptions$2 = {
-  language: Language$1.ARABIC
+  language: Language.ARABIC
 };
 
 var getChapterOptions = function getChapterOptions(options) {
@@ -1122,7 +1312,7 @@ var getChapterOptions = function getChapterOptions(options) {
 /**
  * Get all chapters.
  * @description https://quran.api-docs.io/v4/chapters/list-chapters
- * @param {Options} options
+ * @param {GetChapterOptions} options
  * @example
  * quran.v4.chapters.findAll()
  */
@@ -1161,7 +1351,7 @@ var findAll$1 = /*#__PURE__*/function () {
  * Get chapter by id.
  * @description https://quran.api-docs.io/v4/chapters/get-chapter
  * @param {ChapterId} id chapter id, minimum 1, maximum 114
- * @param {Options} options
+ * @param {GetChapterOptions} options
  * @example
  * quran.v4.chapters.findById('1')
  * quran.v4.chapters.findById('114')
@@ -1209,7 +1399,7 @@ var findById = /*#__PURE__*/function () {
  * 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 {Options} options
+ * @param {GetChapterOptions} options
  * @example
  * quran.v4.chapters.findInfoById('1')
  * quran.v4.chapters.findInfoById('114')
@@ -1261,7 +1451,7 @@ var chapters = {
 };
 
 var defaultOptions$1 = {
-  language: Language$1.ARABIC,
+  language: Language.ARABIC,
   perPage: 50
 };
 
@@ -1645,7 +1835,7 @@ var juzs = {
 };
 
 var defaultChapterRecitationsOptions = {
-  language: Language$1.ARABIC
+  language: Language.ARABIC
 };
 
 var getChapterRecitationsOptions = function getChapterRecitationsOptions(options) {
@@ -1659,7 +1849,7 @@ var getChapterRecitationsOptions = function getChapterRecitationsOptions(options
 };
 
 var defaultVerseRecitationsOptions = {
-  language: Language$1.ARABIC
+  language: Language.ARABIC
 };
 
 var getVerseRecitationsOptions = function getVerseRecitationsOptions(options) {
@@ -1692,7 +1882,7 @@ var getVerseRecitationsOptions = function getVerseRecitationsOptions(options) {
  * 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 {GetChapterRecitationsOptions} options
+ * @param {GetChapterRecitationOptions} options
  * @example
  * quran.v4.audio.findAllChapterRecitations('2')
  */
@@ -1732,7 +1922,7 @@ var findAllChapterRecitations = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-single-surah-audio-for-specific-reciter
  * @param {ChapterId} chapterId
  * @param {string} reciterId
- * @param {GetChapterRecitationsOptions} options
+ * @param {GetChapterRecitationOptions} options
  * @example
  * quran.v4.audio.findChapterRecitationById('1', '2') // first chapter recitation for reciter 2
  */
@@ -1780,7 +1970,7 @@ var findChapterRecitationById = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-surah
  * @param {ChapterId} chapterId
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByChapter('1', '2')
  */
@@ -1872,7 +2062,7 @@ var findVerseRecitationsByJuz = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-madani-mushaf-page
  * @param {PageNumber} page
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByPage('1', '2')
  */
@@ -1918,7 +2108,7 @@ var findVerseRecitationsByPage = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-rub
  * @param {RubNumber} rub
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByRub('1', '2')
  */
@@ -1964,7 +2154,7 @@ var findVerseRecitationsByRub = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-hizb
  * @param {HizbNumber} hizb
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByHizb('1', '2')
  */
@@ -2006,11 +2196,11 @@ var findVerseRecitationsByHizb = /*#__PURE__*/function () {
   };
 }();
 /**
- * Get all verse audio files for a specific reciter and a specific hizb
+ * 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 {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByKey('1:1', '2')
  */
@@ -2064,7 +2254,7 @@ var audio = {
 };
 
 var defaultOptions = {
-  language: Language$1.ARABIC
+  language: Language.ARABIC
 };
 
 var getResourcesOptions = function getResourcesOptions(options) {
@@ -2079,7 +2269,7 @@ var getResourcesOptions = function getResourcesOptions(options) {
 /**
  * Get all recitations.
  * @description https://quran.api-docs.io/v4/resources/recitations
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllRecitations()
  */
@@ -2119,11 +2309,11 @@ var findAllRecitations = /*#__PURE__*/function () {
  * 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;
@@ -2134,7 +2324,7 @@ var findAllRecitations = /*#__PURE__*/function () {
 /**
  * Get all translations.
  * @description https://quran.api-docs.io/v4/resources/translations
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllTranslations()
  */
@@ -2174,11 +2364,11 @@ var findAllTranslations = /*#__PURE__*/function () {
  * 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;
@@ -2189,7 +2379,7 @@ var findAllTranslations = /*#__PURE__*/function () {
 /**
  * Get all tafsirs.
  * @description https://quran.api-docs.io/v4/resources/tafsirs
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllTafsirs()
  */
@@ -2229,11 +2419,11 @@ var findAllTafsirs = /*#__PURE__*/function () {
  * 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;
@@ -2280,7 +2470,7 @@ var findAllRecitationStyles = /*#__PURE__*/function () {
 /**
  * Get all languages.
  * @description https://quran.api-docs.io/v4/resources/languages
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllLanguages()
  */
@@ -2318,7 +2508,7 @@ var findAllLanguages = /*#__PURE__*/function () {
 /**
  * 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()
  */
@@ -2356,7 +2546,7 @@ var findAllChapterInfos = /*#__PURE__*/function () {
 /**
  * Get verse media.
  * @description https://quran.api-docs.io/v4/resources/verse_media
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findVerseMedia()
  */
@@ -2394,7 +2584,7 @@ var findVerseMedia = /*#__PURE__*/function () {
 /**
  * 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()
  */
@@ -2445,7 +2635,7 @@ var resources = {
 };
 
 var defaultSearchOptions = {
-  language: Language$1.ARABIC,
+  language: Language.ARABIC,
   size: 30
 };
 
@@ -2463,13 +2653,13 @@ var getSearchOptions = function getSearchOptions(q, options) {
 /**
  * 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 })
  */
 
 
@@ -2521,98 +2711,5 @@ var quran = {
   utils: Utils
 };
 
-var CharType;
-
-(function (CharType) {
-  CharType["Word"] = "word";
-  CharType["End"] = "end";
-  CharType["Pause"] = "pause";
-  CharType["Sajdah"] = "sajdah";
-  CharType["RubElHizb"] = "rub-el-hizb";
-})(CharType || (CharType = {}));
-
-var Language;
-
-(function (Language) {
-  Language["ARABIC"] = "ar";
-  Language["ENGLISH"] = "en";
-  Language["URDU"] = "ur";
-  Language["BENGALI"] = "bn";
-  Language["TURKISH"] = "tr";
-  Language["SPANISH"] = "es";
-  Language["GERMAN"] = "de";
-  Language["BOSNIAN"] = "bs";
-  Language["RUSSIAN"] = "ru";
-  Language["ALBANIAN_AL"] = "al";
-  Language["FRENCH"] = "fr";
-  Language["DUTCH"] = "nl";
-  Language["TAMIL"] = "ta";
-  Language["TAJIK"] = "tg";
-  Language["INDONESIAN"] = "id";
-  Language["UZBEK"] = "uz";
-  Language["VIETNAMESE"] = "vi";
-  Language["CHINESE"] = "zh";
-  Language["ITALIAN"] = "it";
-  Language["JAPANESE"] = "ja";
-  Language["MALAYALAM"] = "ml";
-  Language["AMHARIC"] = "am";
-  Language["KAZAKH"] = "kk";
-  Language["PORTUGUESE"] = "pt";
-  Language["TAGALOG"] = "tl";
-  Language["THAI"] = "th";
-  Language["KOREAN"] = "ko";
-  Language["HINDI"] = "hi";
-  Language["KURDISH"] = "ku";
-  Language["HAUSA"] = "ha";
-  Language["AZERI"] = "az";
-  Language["SWAHILI"] = "sw";
-  Language["PERSIAN"] = "fa";
-  Language["SERBIAN"] = "sr";
-  Language["MARANAO"] = "mrn";
-  Language["AMAZIGH"] = "zgh";
-  Language["ASSAMESE"] = "as";
-  Language["BULGARIAN"] = "bg";
-  Language["CHECHEN"] = "ce";
-  Language["CZECH"] = "cs";
-  Language["DIVEHI"] = "dv";
-  Language["DHIVEHI"] = "dv";
-  Language["MALDIVIAN"] = "dv";
-  Language["FINNISH"] = "fi";
-  Language["GUJAARATI"] = "gu";
-  Language["HEBREW"] = "he";
-  Language["GEORGIAN"] = "ka";
-  Language["CENTRAL_KHMER"] = "km";
-  Language["GANDA"] = "lg";
-  Language["MARATHI"] = "mr";
-  Language["YORUBA"] = "yo";
-  Language["MALAY"] = "ms";
-  Language["NEPALI"] = "ne";
-  Language["SWEDISH"] = "sv";
-  Language["TELUGU"] = "te";
-  Language["TATAR"] = "tt";
-  Language["UIGHUR"] = "ug";
-  Language["UYGHUR"] = "ug";
-  Language["UKRAINIAN"] = "uk";
-  Language["NORWEGIAN"] = "no";
-  Language["OROMO"] = "om";
-  Language["POLISH"] = "pl";
-  Language["PASHTO"] = "ps";
-  Language["ROMANIAN"] = "ro";
-  Language["SINDHI"] = "sd";
-  Language["NORTHERN_SAMI"] = "se";
-  Language["SINHALA"] = "si";
-  Language["SINHALESE"] = "si";
-  Language["SOMALI"] = "so";
-  Language["ALBANIAN_SQ"] = "sq";
-})(Language || (Language = {}));
-
-var QuranFont;
-
-(function (QuranFont) {
-  QuranFont["MadaniV1"] = "code_v1";
-  QuranFont["MadaniV2"] = "code_v2";
-  QuranFont["Uthmani"] = "text_uthmani";
-})(QuranFont || (QuranFont = {}));
-
 export { CharType, Language, QuranFont, quran };
 //# sourceMappingURL=api.esm.js.map