@quranjs/api 3.7.0 → 3.9.0

package/dist/index-BJ5hWalX.d.ts

@@ -1,292 +0,0 @@
-type ApiParams = Record<string, string | number | boolean | unknown[] | undefined | Record<string, boolean>>;
-/**
- * Base parameters that are common across most API endpoints
- */
-interface BaseApiParams extends ApiParams {
-    /** Language for the response */
-    language?: Language;
-}
-/**
- * Pagination parameters
- */
-interface PaginationParams extends ApiParams {
-    /** Page number for pagination */
-    page?: number;
-    /** Number of items per page */
-    perPage?: number;
-}
-type BinaryString = "0" | "1";
-declare enum SearchMode {
-    Advanced = "advanced",
-    Quick = "quick"
-}
-/**
- * Search parameters
- */
-interface SearchParams extends BaseApiParams {
-    /** Search mode */
-    mode: SearchMode;
-    /** Search query */
-    query: string;
-    /** Filter translations */
-    filterTranslations?: string | string[];
-    /** For advanced search, limit to exact matches */
-    exactMatchesOnly?: BinaryString;
-    /** Include text in the response */
-    getText?: BinaryString;
-    /** Include highlighted text */
-    highlight?: BinaryString;
-    /** Quick search navigational results count */
-    navigationalResultsNumber?: number;
-    /** Quick search verse results count */
-    versesResultsNumber?: number;
-    /** Comma-separated list of indexes */
-    indexes?: string | string[];
-    /** Page number for pagination */
-    page?: number;
-    /** Number of results to return */
-    size?: number;
-    /** Translation IDs to use for language detection */
-    translationIds?: string | number | Array<string | number>;
-    /** Quran fields to include in verse filters */
-    fields?: Partial<Record<VerseField, boolean>>;
-    /** Translation fields to include in verse filters */
-    translationFields?: Partial<Record<TranslationField, boolean>>;
-    /** Word fields to include in verse filters */
-    wordFields?: Partial<Record<WordField, boolean>>;
-    /** Include word data in verse filters */
-    words?: boolean;
-}
-
-type AuthService = "auth" | "quranReflect";
-
-/**
- * Custom fetcher function type that matches the native fetch API
- */
-type CustomFetcher = typeof fetch;
-type RuntimeMode = "server" | "public";
-type HTTPMethod = "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
-interface QuranFetchClient {
-    fetch<T = unknown>(url: string, params?: ApiParams): Promise<T>;
-}
-type ApiService = "analytics" | "content" | "search" | AuthService | "oauth2";
-interface ServiceEnvironmentConfig {
-    gatewayUrl?: string;
-    tokenHost?: string;
-    oauth2BaseUrl?: string;
-    analyticsBaseUrl?: string;
-    contentBaseUrl?: string;
-    searchBaseUrl?: string;
-    authBaseUrl?: string;
-    quranReflectBaseUrl?: string;
-}
-interface QuranClientConfig {
-    /** Client ID for authentication */
-    clientId: string;
-    /** Client secret for authentication */
-    clientSecret: string;
-    /** Legacy gateway base URL for content/search APIs */
-    contentBaseUrl?: string;
-    /** Legacy OAuth2 token host URL */
-    authBaseUrl?: string;
-    /** Custom fetch implementation */
-    fetch?: CustomFetcher;
-    /** Default parameters for all API calls */
-    defaults?: Partial<BaseApiParams>;
-}
-interface UserSession {
-    accessToken: string;
-    refreshToken?: string;
-    idToken?: string;
-    scope?: string;
-    tokenType?: string;
-    expiresAt?: number;
-}
-interface TokenStorage {
-    getSession?: () => UserSession | null | undefined | Promise<UserSession | null | undefined>;
-    setSession?: (session: UserSession | null) => void | Promise<void>;
-    clearSession?: () => void | Promise<void>;
-}
-interface BaseRuntimeClientConfig {
-    clientId: string;
-    fetch?: CustomFetcher;
-    defaults?: Partial<BaseApiParams>;
-    services?: ServiceEnvironmentConfig;
-    userSession?: UserSession;
-    storage?: TokenStorage;
-}
-interface ServerClientConfig extends BaseRuntimeClientConfig {
-    clientSecret: string;
-}
-interface PublicClientConfig extends BaseRuntimeClientConfig {
-    clientType: "public" | "confidential-proxy";
-}
-interface CachedToken {
-    value: string;
-    expiresAt: number;
-}
-interface TokenResponse {
-    access_token: string;
-    token_type?: string;
-    expires_in: number;
-    refresh_token?: string;
-    id_token?: string;
-    scope?: string;
-}
-interface OperationRequest {
-    path?: Record<string, string | number>;
-    query?: ApiParams;
-    body?: string | URLSearchParams | Record<string, unknown> | null;
-    headers?: Record<string, string>;
-    method?: HTTPMethod;
-    auth?: "auto" | "none" | "app" | "user";
-    accessToken?: string;
-    basicAuth?: {
-        username: string;
-        password: string;
-    };
-    contentType?: string;
-}
-
-interface QuranReflectPostReference {
-    chapterId: number;
-    from: number;
-    to: number;
-    id?: string;
-}
-interface QuranReflectPostMention {
-    marker: string;
-    userId: string;
-    displayName: string;
-}
-type QuranReflectRoomPostStatus = 0 | 1 | 2;
-interface CreateQuranReflectPostPayload {
-    body: string;
-    draft: boolean;
-    references: QuranReflectPostReference[];
-    mentions: QuranReflectPostMention[];
-    roomId?: number;
-    roomPostStatus?: QuranReflectRoomPostStatus;
-    postAsAuthorId?: string;
-    publishedAt?: string | Date;
-}
-type UpdateQuranReflectPostPayload = Partial<CreateQuranReflectPostPayload>;
-interface QuranReflectPost {
-    id: number | string;
-    authorId?: string;
-    body?: string;
-    commentsCount?: number;
-    createdAt?: string;
-    discussionId?: number;
-    draft?: boolean;
-    estimatedReadingTime?: number;
-    featuredAt?: string;
-    global?: boolean;
-    hidden?: boolean;
-    languageId?: number;
-    languageName?: string;
-    likesCount?: number;
-    mentions?: QuranReflectPostMention[];
-    moderationStatus?: number;
-    postTypeId?: number | null;
-    postTypeName?: string;
-    publishedAt?: string;
-    pushedUpAt?: string;
-    references?: QuranReflectPostReference[];
-    removed?: boolean;
-    reported?: boolean;
-    reviewedAt?: string;
-    roomId?: number | null;
-    roomPostStatus?: number;
-    toxicityScore?: number;
-    updatedAt?: string;
-    verified?: boolean;
-    views?: number;
-    viewsCount?: number;
-}
-interface QuranReflectPostMutationResponse {
-    success: boolean;
-    data?: QuranReflectPost;
-    post?: QuranReflectPost;
-    error?: unknown;
-}
-
-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",
-    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",
-    UYGHUR = "ug",
-    UKRAINIAN = "uk",
-    NORWEGIAN = "no",
-    OROMO = "om",
-    POLISH = "pl",
-    PASHTO = "ps",
-    ROMANIAN = "ro",
-    SINDHI = "sd",
-    NORTHERN_SAMI = "se",
-    SINHALA = "si",
-    SOMALI = "so",
-    ALBANIAN_SQ = "sq"
-}
-declare enum QuranFont {
-    MadaniV1 = "code_v1",
-    MadaniV2 = "code_v2",
-    Uthmani = "text_uthmani"
-}
-type VerseField = "chapterId" | "textUthmani" | "textUthmaniSimple" | "textImlaei" | "textImlaeiSimple" | "textIndopak" | "textIndopakNastaleeq" | "textUthmaniTajweed" | "imageUrl" | "imageWidth" | "codeV1" | "codeV2" | "v1Page" | "v2Page";
-type WordField = "v1Page" | "v2Page" | "textUthmani" | "textImlaei" | "textIndopak" | "verseKey" | "location" | "codeV1" | "codeV2";
-type TranslationField = "resourceName" | "verseId" | "languageId" | "languageName" | "verseKey" | "chapterId" | "verseNumber" | "juzNumber" | "hizbNumber" | "rubNumber" | "pageNumber";
-type VerseRecitationField = "id" | "chapterId" | "segments" | "format";
-
-export { type ApiParams as A, type BaseApiParams as B, type CustomFetcher as C, type HTTPMethod as H, Language as L, type OperationRequest as O, type PaginationParams as P, type QuranClientConfig as Q, type RuntimeMode as R, SearchMode as S, type TranslationField as T, type UserSession as U, type VerseField as V, type WordField as W, QuranFont as a, type VerseRecitationField as b, type BinaryString as c, type SearchParams as d, type QuranFetchClient as e, type ApiService as f, type ServiceEnvironmentConfig as g, type TokenStorage as h, type ServerClientConfig as i, type PublicClientConfig as j, type CachedToken as k, type TokenResponse as l, type QuranReflectPostReference as m, type QuranReflectPostMention as n, type QuranReflectRoomPostStatus as o, type CreateQuranReflectPostPayload as p, type UpdateQuranReflectPostPayload as q, type QuranReflectPost as r, type QuranReflectPostMutationResponse as s };