@quranjs/api 1.7.0 → 1.7.2

package/src/sdk/v4/verses.ts

@@ -1,234 +0,0 @@
-import {
-  ChapterId,
-  HizbNumber,
-  JuzNumber,
-  Language,
-  PageNumber,
-  TranslationField,
-  // RubNumber,
-  Verse,
-  VerseField,
-  VerseKey,
-  WordField,
-} from '../../types';
-import { decamelize } from 'humps';
-import Utils from '../utils';
-import { fetcher, mergeApiOptions } from './_fetcher';
-import { BaseApiOptions } from '../../types/BaseApiOptions';
-
-type GetVerseOptions = Partial<
-  BaseApiOptions & {
-    reciter: string | number;
-    words: boolean;
-    translations: string[] | number[];
-    tafsirs: string[] | number[];
-    wordFields: Partial<Record<WordField, boolean>>;
-    translationFields: Partial<Record<TranslationField, boolean>>;
-    fields: Partial<Record<VerseField, boolean>>;
-    page: number;
-    perPage: number;
-  }
->;
-
-const defaultOptions: GetVerseOptions = {
-  language: Language.ARABIC,
-  perPage: 50,
-  words: false,
-};
-
-const mergeVerseOptions = (options: GetVerseOptions = {}) => {
-  const result = mergeApiOptions(options, defaultOptions);
-
-  // @ts-expect-error - we accept an array of strings, however, the API expects a comma separated string
-  if (result.translations) result.translations = result.translations.join(',');
-
-  // @ts-expect-error - we accept an array of strings, however, the API expects a comma separated string
-  if (result.tafsirs) result.tafsirs = result.tafsirs.join(',');
-
-  if (result.wordFields) {
-    const wordFields: string[] = [];
-    Object.entries(result.wordFields).forEach(([key, value]) => {
-      if (value) wordFields.push(decamelize(key));
-    });
-    result.wordFields = wordFields.join(',');
-  }
-
-  if (result.translationFields) {
-    const translationFields: string[] = [];
-    Object.entries(result.translationFields).forEach(([key, value]) => {
-      if (value) translationFields.push(decamelize(key));
-    });
-    result.translationFields = translationFields.join(',');
-  }
-
-  // rename `reciter` to `audio` because the API expects `audio`
-  if (result.reciter) {
-    result.audio = result.reciter;
-    result.reciter = undefined;
-  }
-
-  return result;
-};
-
-/**
- * Get a specific ayah with key. Key is combination of surah number and ayah number.
- * @description https://quran.api-docs.io/v4/verses/by-specific-verse-by-key
- * @param {VerseKey} key - surah number and ayah number separated by a colon.
- * @param {GetVerseOptions} options
- * @example
- * quran.v4.verses.findByKey('1:1')
- * quran.v4.verses.findByKey('101:5')
- */
-const findByKey = async (key: VerseKey, options?: GetVerseOptions) => {
-  if (!Utils.isValidVerseKey(key)) throw new Error('Invalid verse key');
-  const params = mergeVerseOptions(options);
-  const url = `/verses/by_key/${key}`;
-  const { verse } = await fetcher<{ verse: Verse }>(
-    url,
-    params,
-    options?.fetchFn
-  );
-
-  return verse;
-};
-
-/**
- * Get all ayahs for a specific chapter (surah).
- * @description https://quran.api-docs.io/v4/verses/by_chapter
- * @param {ChapterId} id - chapter id (surah number)
- * @param {GetVerseOptions} options
- * @example
- * quran.v4.verses.findByChapter('1')
- * quran.v4.verses.findByChapter('101')
- */
-const findByChapter = async (id: ChapterId, options?: GetVerseOptions) => {
-  if (!Utils.isValidChapterId(id)) throw new Error('Invalid chapter id');
-  const params = mergeVerseOptions(options);
-  const url = `/verses/by_chapter/${id}`;
-  const { verses } = await fetcher<{ verses: Verse[] }>(
-    url,
-    params,
-    options?.fetchFn
-  );
-
-  return verses;
-};
-
-/**
- * Get all ayahs for a specific page in the Quran.
- * @description https://quran.api-docs.io/v4/verses/by-page
- * @param {PageNumber} page - Quran page number
- * @param {GetVerseOptions} options
- * @example
- * quran.v4.verses.findByPage('1')
- * quran.v4.verses.findByPage('101')
- */
-const findByPage = async (page: PageNumber, options?: GetVerseOptions) => {
-  if (!Utils.isValidQuranPage(page)) throw new Error('Invalid page');
-
-  const params = mergeVerseOptions(options);
-  const url = `/verses/by_page/${page}`;
-  const { verses } = await fetcher<{ verses: Verse[] }>(
-    url,
-    params,
-    options?.fetchFn
-  );
-
-  return verses;
-};
-
-/**
- * Get all ayahs for a Juz.
- * @description https://quran.api-docs.io/v4/verses/by-juz
- * @param {JuzNumber} id - juz number
- * @param {GetVerseOptions} options
- * @example
- * quran.v4.verses.findByJuz('1')
- * quran.v4.verses.findByJuz('29')
- */
-const findByJuz = async (juz: JuzNumber, options?: GetVerseOptions) => {
-  if (!Utils.isValidJuz(juz)) throw new Error('Invalid juz');
-
-  const params = mergeVerseOptions(options);
-  const url = `/verses/by_juz/${juz}`;
-  const { verses } = await fetcher<{ verses: Verse[] }>(
-    url,
-    params,
-    options?.fetchFn
-  );
-
-  return verses;
-};
-
-/**
- * Get all ayahs for a Hizb.
- * @description https://quran.api-docs.io/v4/verses/by-hizb-number
- * @param {HizbNumber} hizb - hizb number
- * @param {GetVerseOptions} options
- * @example
- * quran.v4.verses.findByHizb('1')
- * quran.v4.verses.findByHizb('29')
- */
-const findByHizb = async (hizb: HizbNumber, options?: GetVerseOptions) => {
-  if (!Utils.isValidHizb(hizb)) throw new Error('Invalid hizb');
-
-  const params = mergeVerseOptions(options);
-  const url = `/verses/by_hizb/${hizb}`;
-  const { verses } = await fetcher<{ verses: Verse[] }>(
-    url,
-    params,
-    options?.fetchFn
-  );
-
-  return verses;
-};
-
-// TODO: uncomment when API is fixed
-/**
- * Get all ayahs for a Rub.
- * @description https://quran.api-docs.io/v4/verses/by-rub-number
- * @param {RubNumber} rub - rub number
- * @param {GetVerseOptions} options
- * @example
- * quran.v4.verses.findByRub('1')
- * quran.v4.verses.findByRub('29')
- */
-// const findByRub = async (rub: RubNumber, options?: GetVerseOptions) => {
-//   if (!Utils.isValidRub(rub)) throw new Error('Invalid rub');
-
-//   const params = getVerseOptions(options);
-//   const url = `/verses/by_rub/${rub}`;
-//   const { verses } = await fetcher<{ verses: Verse[] }>(url, params);
-
-//   return verses;
-// };
-
-/**
- * Get a random ayah.
- * @description https://quran.api-docs.io/v4/verses/random
- * @param {GetVerseOptions} options
- * @example
- * quran.v4.verses.findRandom()
- */
-const findRandom = async (options?: GetVerseOptions) => {
-  const params = mergeVerseOptions(options);
-  const { verse } = await fetcher<{ verse: Verse }>(
-    '/verses/random',
-    params,
-    options?.fetchFn
-  );
-
-  return verse;
-};
-
-const verses = {
-  findByKey,
-  findByChapter,
-  findByPage,
-  findByJuz,
-  findByHizb,
-  // findByRub,
-  findRandom,
-};
-
-export default verses;

package/src/types/BaseApiOptions.ts

@@ -1,6 +0,0 @@
-import { FetchFn, Language } from '.';
-
-export interface BaseApiOptions {
-  language: Language;
-  fetchFn?: FetchFn;
-}

package/src/types/ChapterId.ts

@@ -1,4 +0,0 @@
-import { NumberRange, NumberUnionToString } from './utils';
-
-type _ChapterId = NumberRange<1, 115>;
-export type ChapterId = _ChapterId | NumberUnionToString<_ChapterId>;

package/src/types/FetchFn.ts

@@ -1 +0,0 @@
-export type FetchFn = (url: string) => Promise<Record<string, unknown>>;

package/src/types/HizbNumber.ts

@@ -1,4 +0,0 @@
-import { NumberRange, NumberUnionToString } from './utils';
-
-type _HizbNumber = NumberRange<1, 61>;
-export type HizbNumber = _HizbNumber | NumberUnionToString<_HizbNumber>;

package/src/types/JuzNumber.ts

@@ -1,4 +0,0 @@
-import { NumberRange, NumberUnionToString } from './utils';
-
-type _JuzNumber = NumberRange<1, 31>;
-export type JuzNumber = _JuzNumber | NumberUnionToString<_JuzNumber>;

package/src/types/PageNumber.ts

@@ -1,4 +0,0 @@
-import { NumberRange, NumberUnionToString } from './utils';
-
-type _PageNumber = NumberRange<1, 605>;
-export type PageNumber = _PageNumber | NumberUnionToString<_PageNumber>;

package/src/types/RubNumber.ts

@@ -1,4 +0,0 @@
-import { NumberRange, NumberUnionToString } from './utils';
-
-type _RubNumber = NumberRange<1, 241>;
-export type RubNumber = _RubNumber | NumberUnionToString<_RubNumber>;

package/src/types/VerseKey.ts

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

package/src/types/api/ApiResponses.ts

@@ -1,19 +0,0 @@
-import { Translation } from './Translation';
-import { Word } from './Word';
-
-export interface SearchResponse {
-  search: {
-    query: string;
-    totalResults: number;
-    currentPage: number;
-    totalPages: number;
-    results?: {
-      verseKey: string;
-      verse_id: number;
-      text: string;
-      highlighted: string;
-      words: Word[];
-      translations: Translation[];
-    }[];
-  };
-}

package/src/types/api/AudioData.ts

@@ -1,20 +0,0 @@
-import { VerseKey } from '../VerseKey';
-import { Segment } from './Segment';
-
-export interface ChapterRecitation {
-  id: number;
-  chapterId: number;
-  fileSize: number;
-  format: string;
-  audioUrl: string;
-}
-
-export interface VerseRecitation {
-  verseKey: VerseKey;
-  url: string;
-
-  id?: number;
-  chapterId?: number;
-  segments?: Segment[];
-  format?: string;
-}

package/src/types/api/AudioResponse.ts

@@ -1,9 +0,0 @@
-import { Segment } from './Segment';
-
-export interface AudioResponse {
-  url?: string;
-  duration?: number;
-  format?: string;
-  verseKey: string;
-  segments?: Segment[];
-}

package/src/types/api/Chapter.ts

@@ -1,15 +0,0 @@
-import { TranslatedName } from './TranslatedName';
-
-export interface Chapter {
-  id: number;
-  versesCount: number;
-  bismillahPre: boolean;
-  revelationOrder: number;
-  revelationPlace: string;
-  pages: Array<number>;
-  nameComplex: string;
-  nameSimple: string;
-  transliteratedName: string;
-  nameArabic: string;
-  translatedName: TranslatedName;
-}

package/src/types/api/ChapterInfo.ts

@@ -1,8 +0,0 @@
-export interface ChapterInfo {
-  id: number;
-  chapterId: number;
-  text: string;
-  shortText: string;
-  source: string;
-  languageName?: string;
-}

package/src/types/api/Footnote.ts

@@ -1,6 +0,0 @@
-export interface Footnote {
-  id: number | string;
-  text: string;
-  languageName?: string;
-  languageId?: number;
-}

package/src/types/api/Juz.ts

@@ -1,8 +0,0 @@
-export interface Juz {
-  id: number;
-  juzNumber: number;
-  verseMapping: Record<number, string>;
-  firstVerseId: number;
-  lastVerseId: number;
-  versesCount: number;
-}

package/src/types/api/Pagination.ts

@@ -1,7 +0,0 @@
-export interface Pagination {
-  perPage: number;
-  currentPage: number;
-  nextPage: number;
-  totalPages: number;
-  totalRecords: number;
-}

package/src/types/api/Reciter.ts

@@ -1,21 +0,0 @@
-export interface Reciter {
-  id: number;
-  name: string;
-  recitationStyle: string;
-  relativePath: string;
-  profilePicture?: string;
-  coverImage?: string;
-  bio?: string;
-  qirat?: {
-    languageName: string;
-    name: string;
-  };
-  style?: {
-    languageName: string;
-    name: string;
-  };
-  translatedName?: {
-    languageName: string;
-    name: string;
-  };
-}

package/src/types/api/Resources.ts

@@ -1,81 +0,0 @@
-import { TranslatedName } from './TranslatedName';
-
-export interface RecitationResource {
-  id?: number;
-  reciterName?: string;
-  style?: string;
-  translatedName?: TranslatedName;
-}
-
-export interface RecitationInfoResource {
-  id?: number;
-  info?: string;
-}
-
-export interface TranslationResource {
-  id?: number;
-  name?: string;
-  authorName?: string;
-  slug?: string;
-  languageName?: string;
-  translatedName?: TranslatedName;
-}
-
-export interface TranslationInfoResource {
-  id?: number;
-  info?: string;
-}
-
-export interface TafsirResource {
-  id?: number;
-  name?: string;
-  authorName?: string;
-  slug?: string;
-  languageName?: string;
-  translatedName?: TranslatedName;
-}
-
-export interface TafsirInfoResource {
-  id?: number;
-  info?: string;
-}
-
-export interface RecitationStylesResource {
-  mujawwad: string;
-  murattal: string;
-  muallim: string;
-}
-
-export interface LanguageResource {
-  id?: number;
-  name?: string;
-  nativeName?: string;
-  isoCode?: string;
-  direction?: string;
-  translatedNames?: TranslatedName[];
-}
-
-export interface ChapterInfoResource {
-  id?: number;
-  name?: string;
-  authorName?: string;
-  slug?: string;
-  languageName?: string;
-  translatedName?: TranslatedName;
-}
-
-export interface VerseMediaResource {
-  id?: number;
-  name?: string;
-  authorName?: string;
-  languageName?: string;
-}
-
-export interface ChapterReciterResource {
-  id: number;
-  name: string;
-  arabicName?: string;
-  relativePath?: string;
-  format?: string;
-  filesSize?: number; // in kb
-}

package/src/types/api/Segment.ts

@@ -1,4 +0,0 @@
-/**
- * Segment structure is [wordFrom, wordTo, timeFrom, timeTo] time is in ms
- */
-export type Segment = [number, number, number, number];

package/src/types/api/Tafsir.ts

@@ -1,7 +0,0 @@
-export interface Tafsir {
-  id?: number;
-  resourceId?: number;
-  text?: string;
-  resourceName?: string;
-  languageName?: string;
-}

package/src/types/api/TafsirInfo.ts

@@ -1,10 +0,0 @@
-import { TranslatedName } from './TranslatedName';
-
-export interface TafsirInfo {
-  id?: number;
-  name?: string;
-  authorName?: string;
-  slug?: string;
-  languageName?: string;
-  translatedName: TranslatedName;
-}

package/src/types/api/TranslatedName.ts

@@ -1,4 +0,0 @@
-export interface TranslatedName {
-  name: string;
-  languageName: string;
-}

package/src/types/api/Translation.ts

@@ -1,21 +0,0 @@
-import { VerseKey } from '../VerseKey';
-
-export interface Translation {
-  id?: number;
-  text: string;
-  resourceId: number;
-  resourceName?: string;
-
-  verseId?: number;
-
-  languageId?: number;
-  languageName?: string;
-
-  verseKey?: VerseKey;
-  chapterId?: number;
-  verseNumber?: number;
-  juzNumber?: number;
-  hizbNumber?: number;
-  rubNumber?: number;
-  pageNumber?: number;
-}

package/src/types/api/Transliteration.ts

@@ -1,4 +0,0 @@
-export interface Transliteration {
-  languageName?: string;
-  text?: string;
-}