@quranjs/api 1.6.0 → 1.7.0

package/dist/types/api/Reciter.d.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/dist/types/api/Resources.d.ts

@@ -1,70 +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;
-}

package/dist/types/api/Segment.d.ts

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

package/dist/types/api/Tafsir.d.ts

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

package/dist/types/api/TafsirInfo.d.ts

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

package/dist/types/api/TranslatedName.d.ts

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

package/dist/types/api/Translation.d.ts

@@ -1,17 +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/dist/types/api/Transliteration.d.ts

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

package/dist/types/api/Verse.d.ts

@@ -1,32 +0,0 @@
-import { VerseKey } from '../VerseKey';
-import { AudioResponse } from './AudioResponse';
-import { Tafsir } from './Tafsir';
-import { Translation } from './Translation';
-import { Word } from './Word';
-export interface Verse {
-    id: number;
-    verseNumber: number;
-    verseKey: VerseKey;
-    chapterId?: number | string;
-    pageNumber: number;
-    juzNumber: number;
-    hizbNumber: number;
-    rubElHizbNumber: number;
-    words?: Word[];
-    textUthmani?: string;
-    textUthmaniSimple?: string;
-    textUthmaniTajweed?: string;
-    textImlaei?: string;
-    textImlaeiSimple?: string;
-    textIndopak?: string;
-    sajdahNumber: null;
-    imageUrl?: string;
-    imageWidth?: number;
-    v1Page?: number;
-    v2Page?: number;
-    codeV1?: string;
-    codeV2?: string;
-    translations?: Translation[];
-    tafsirs?: Tafsir[];
-    audio?: AudioResponse;
-}

package/dist/types/api/Word.d.ts

@@ -1,28 +0,0 @@
-import { VerseKey } from '../VerseKey';
-import { Translation } from './Translation';
-import { Transliteration } from './Transliteration';
-export declare enum CharType {
-    Word = "word",
-    End = "end",
-    Pause = "pause",
-    Sajdah = "sajdah",
-    RubElHizb = "rub-el-hizb"
-}
-export interface Word {
-    id?: number;
-    position: number;
-    audioUrl: string;
-    charTypeName: CharType;
-    codeV1?: string;
-    codeV2?: string;
-    pageNumber?: number;
-    lineNumber?: number;
-    text?: string;
-    textUthmani?: string;
-    textIndopak?: string;
-    textImlaei?: string;
-    translation: Translation;
-    transliteration: Transliteration;
-    location?: string;
-    verseKey?: VerseKey;
-}

package/dist/types/api/index.d.ts

@@ -1,18 +0,0 @@
-export * from './ApiResponses';
-export * from './AudioData';
-export * from './AudioResponse';
-export * from './Chapter';
-export * from './ChapterInfo';
-export * from './Footnote';
-export * from './Reciter';
-export * from './Segment';
-export * from './Tafsir';
-export * from './TafsirInfo';
-export * from './TranslatedName';
-export * from './Translation';
-export * from './Transliteration';
-export * from './Verse';
-export * from './Word';
-export * from './Juz';
-export * from './Pagination';
-export * from './Resources';

package/dist/types/index.d.ts

@@ -1,88 +0,0 @@
-export declare enum Language {
-    ARABIC = "ar",
-    ENGLISH = "en",
-    URDU = "ur",
-    BENGALI = "bn",
-    TURKISH = "tr",
-    SPANISH = "es",
-    GERMAN = "de",
-    BOSNIAN = "bs",
-    RUSSIAN = "ru",
-    ALBANIAN_AL = "al",
-    FRENCH = "fr",
-    DUTCH = "nl",
-    TAMIL = "ta",
-    TAJIK = "tg",
-    INDONESIAN = "id",
-    UZBEK = "uz",
-    VIETNAMESE = "vi",
-    CHINESE = "zh",
-    ITALIAN = "it",
-    JAPANESE = "ja",
-    MALAYALAM = "ml",
-    AMHARIC = "am",
-    KAZAKH = "kk",
-    PORTUGUESE = "pt",
-    TAGALOG = "tl",
-    THAI = "th",
-    KOREAN = "ko",
-    HINDI = "hi",
-    KURDISH = "ku",
-    HAUSA = "ha",
-    AZERI = "az",
-    SWAHILI = "sw",
-    PERSIAN = "fa",
-    SERBIAN = "sr",
-    MARANAO = "mrn",
-    AMAZIGH = "zgh",
-    ASSAMESE = "as",
-    BULGARIAN = "bg",
-    CHECHEN = "ce",
-    CZECH = "cs",
-    DIVEHI = "dv",
-    DHIVEHI = "dv",
-    MALDIVIAN = "dv",
-    FINNISH = "fi",
-    GUJAARATI = "gu",
-    HEBREW = "he",
-    GEORGIAN = "ka",
-    CENTRAL_KHMER = "km",
-    GANDA = "lg",
-    MARATHI = "mr",
-    YORUBA = "yo",
-    MALAY = "ms",
-    NEPALI = "ne",
-    SWEDISH = "sv",
-    TELUGU = "te",
-    TATAR = "tt",
-    UIGHUR = "ug",
-    UYGHUR = "ug",
-    UKRAINIAN = "uk",
-    NORWEGIAN = "no",
-    OROMO = "om",
-    POLISH = "pl",
-    PASHTO = "ps",
-    ROMANIAN = "ro",
-    SINDHI = "sd",
-    NORTHERN_SAMI = "se",
-    SINHALA = "si",
-    SINHALESE = "si",
-    SOMALI = "so",
-    ALBANIAN_SQ = "sq"
-}
-export declare enum QuranFont {
-    MadaniV1 = "code_v1",
-    MadaniV2 = "code_v2",
-    Uthmani = "text_uthmani"
-}
-export declare type VerseField = 'chapterId' | 'textUthmani' | 'textUthmaniSimple' | 'textImlaei' | 'textImlaeiSimple' | 'textIndopak' | 'textUthmaniTajweed' | 'imageUrl' | 'imageWidth' | 'codeV1' | 'codeV2' | 'v1Page' | 'v2Page';
-export declare type WordField = 'v1Page' | 'v2Page' | 'textUthmani' | 'textImlaei' | 'textIndopak' | 'verseKey' | 'location' | 'codeV1' | 'codeV2';
-export declare type TranslationField = 'resourceName' | 'verseId' | 'languageId' | 'languageName' | 'verseKey' | 'chapterId' | 'verseNumber' | 'juzNumber' | 'hizbNumber' | 'rubNumber' | 'pageNumber';
-export declare type VerseRecitationField = 'id' | 'chapterId' | 'segments' | 'format';
-export * from './VerseKey';
-export * from './ChapterId';
-export * from './HizbNumber';
-export * from './JuzNumber';
-export * from './PageNumber';
-export * from './RubNumber';
-export * from './api';

package/dist/types/utils.d.ts

@@ -1,5 +0,0 @@
-declare type _NumbersFrom0ToN<Nr extends number> = Nr extends Nr ? number extends Nr ? number : Nr extends 0 ? never : _NumbersFrom0ToNRec<Nr, [], 0> : never;
-declare type _NumbersFrom0ToNRec<Nr extends number, Counter extends any[], Accumulator extends number> = Counter['length'] extends Nr ? Accumulator : _NumbersFrom0ToNRec<Nr, [any, ...Counter], Accumulator | Counter['length']>;
-export declare type NumberRange<Start extends number, End extends number> = Exclude<_NumbersFrom0ToN<End>, _NumbersFrom0ToN<Start>>;
-export declare type NumberUnionToString<TType> = TType extends number ? `${TType}` : TType;
-export {};

package/dist/utils/misc.d.ts

@@ -1 +0,0 @@
-export declare const removeBeginningSlash: (url: string) => string;

package/dist/utils/qs-stringify.d.ts

@@ -1,21 +0,0 @@
-declare type QueryObject = Record<string, any>;
-export declare type StringifyFunction = (key: string, value: any) => any;
-declare type Config = {
-    eq?: string;
-    sep?: string;
-    fn?: StringifyFunction;
-    prefix?: string;
-};
-/**
- * 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'
- */
-declare function stringify(obj: QueryObject, config?: Config): string;
-export default stringify;

package/src/utils/qs-stringify.ts

@@ -1,81 +0,0 @@
-// Reference: https://github.com/billjs/query-string/blob/master/src/index.ts
-
-type QueryObject = Record<string, any>;
-export type StringifyFunction = (key: string, value: any) => any;
-type Config = {
-  eq?: string;
-  sep?: string;
-  fn?: StringifyFunction;
-  prefix?: string;
-};
-
-const defaultStringifyFunction: StringifyFunction = (
-  _key: string,
-  value: any
-) => value;
-const defaultEq = '=';
-const defaultSep = '&';
-const defaultConfig: Config = {
-  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: QueryObject, config = defaultConfig): string {
-  const { eq, sep, fn, prefix } = { ...defaultConfig, ...config };
-  if (obj == null || !isObject(obj)) {
-    return '';
-  }
-
-  return Object.entries(obj)
-    .filter(([, value]) => value !== null) // filter out null values
-    .map(([key, value]) => {
-      if (Array.isArray(value))
-        return encode(key, value.join(','), { eq, fn, prefix });
-
-      if (isObject(value))
-        return stringify(value, { eq, sep, fn, prefix: getKey(key, prefix) });
-
-      return encode(key, value, { eq, fn, prefix });
-    })
-    .join(sep);
-}
-
-// encode the key and add prefix if necessary
-const getKey = (key: string, prefix = ''): string => {
-  const encodedKey = encodeURIComponent(key);
-  if (prefix) return `${prefix}[${encodedKey}]`;
-  return encodedKey;
-};
-
-// encode the key and value of a query object
-const encode = (
-  key: string,
-  value: any,
-  { eq = defaultEq, fn = defaultStringifyFunction, prefix = '' }
-): string => {
-  const newValue = encodeURIComponent(fn(key, value));
-  const newKey = getKey(key, prefix);
-
-  return [newKey, newValue].join(eq);
-};
-
-// check if the given value is an object
-function isObject(obj: QueryObject) {
-  const type = typeof obj;
-  return (obj && (type === 'object' || type === 'function')) || false;
-}
-
-export default stringify;