ترجمات وكتب وفصول

export interface AvailableTranslations {
    /**
     * قائمة الترجمات.
     */
    translations: Translation[];
}

interface Translation {
    /**
     * معرّف الترجمة.
     */
    id: string;

    /**
     * اسم الترجمة.
     * هذا عادةً ما يكون اسم الترجمة في لغة الترجمة.
     */
    name: string;

    /**
     * الاسم الإنجليزي للترجمة.
     */
    englishName: string;

    /**
     * موقع الترجمة.
     */
    website: string;

    /**
     * الرابط الذي يمكن من خلاله العثور على ترخيص الترجمة.
     */
    licenseUrl: string;

    /**
     * الاسم المختصر للترجمة.
     */
    shortName: string;

    /**
     * رمز اللغة المكون من 3 أحرف وفقًا لمعيار ISO 639 والذي تتم الترجمة به بشكل أساسي.
     */
    language: string;

    /**
     * يحصل على اسم اللغة التي تمت بها الترجمة.
     * قيمة فارغة أو غير محددة إذا كان اسم اللغة غير معروف.
     */
    languageName?: string;

    /**
     * يحصل على اسم اللغة باللغة الإنجليزية.
     * قيمة فارغة أو غير محددة إذا لم يكن للغة اسم إنجليزي.
     */
    languageEnglishName?: string;

    /**
     * الاتجاه الذي تُكتب به اللغة.
     * يشير الرمز "ltr" إلى أن النص مكتوب من الجانب الأيسر للصفحة إلى الجانب الأيمن.
     * يشير الرمز "rtl" إلى أن النص مكتوب من الجانب الأيمن للصفحة إلى الجانب الأيسر.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * قائمة التنسيقات المتاحة.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * رابط واجهة برمجة التطبيقات (API) لقائمة الكتب المتاحة لهذه الترجمة.
     */
    listOfBooksApiLink: string;

    /**
     * عدد الكتب التي تتضمنها هذه الترجمة.
     *
     * ينبغي أن تحتوي الترجمات الكاملة على نفس عدد الكتب الموجودة في الكتاب المقدس (66).
     */
    numberOfBooks: number;

    /**
     * إجمالي عدد الفصول التي تتضمنها هذه الترجمة.
     *
     * ينبغي أن تحتوي الترجمات الكاملة على نفس عدد الفصول الموجودة في الكتاب المقدس (1189).
     */
    totalNumberOfChapters: number;

    /**
     * إجمالي عدد الآيات الواردة في هذه الترجمة.
     *
     * ينبغي أن تحتوي الترجمات الكاملة على نفس عدد الآيات الموجودة في الكتاب المقدس (حوالي 31102 - بعض الترجمات تستبعد الآيات بناءً على الاحتمالية الظاهرة لوجودها في النصوص المصدرية الأصلية).
     */
    totalNumberOfVerses: number;

    /**
     * العدد الإجمالي للكتب المنحولة التي تحتويها هذه الترجمة.
     * يتم حذف النص إذا لم تتضمن الترجمة الأبوكريفا.
     */
    numberOfApocryphalBooks?: number;

    /**
     * إجمالي عدد الفصول المنحولة التي تحتويها هذه الترجمة.
     * يتم حذف النص إذا لم تتضمن الترجمة الأبوكريفا.
     */
    totalNumberOfApocryphalChapters?: number;

    /**
     * العدد الإجمالي للآيات المنحولة التي تحتويها هذه الترجمة.
     * يتم حذف النص إذا لم تتضمن الترجمة الأبوكريفا.
     */
    totalNumberOfApocryphalVerses?: number;
}

export interface TranslationBooks {
    /**
     * معلومات الترجمة الخاصة بالكتب.
     */
    translation: Translation;

    /**
     * قائمة الكتب المتاحة للترجمة.
     */
    books: TranslationBook[];
}

interface TranslationBook {
    /**
     * رقم تعريف الكتاب.
     */
    id: string;

    /**
     * الاسم الذي قدمته الترجمة للكتاب.
     */
    name: string;

    /**
     * الاسم الشائع للكتاب.
     */
    commonName: string;

    /**
     * عنوان الكتاب.
     * عادةً ما تكون هذه نسخة أكثر وصفية لاسم الكتاب.
     * إذا لم يكن متوفراً، فهذا يعني أن الترجمة لم تقدمه.
     */
    title: string | null;

    /**
     * الترتيب العددي للكتاب في الترجمة.
     */
    order: number;

    /**
     * عدد الفصول التي يحتويها الكتاب.
     */
    numberOfChapters: number;

    /**
     * رقم الفصل الأول في الكتاب.
     */
    firstChapterNumber: number;

    /**
     * رابط الفصل الأول من الكتاب.
     */
    firstChapterApiLink: string;

    /**
     * رقم الفصل الأخير في الكتاب.
     */
    lastChapterNumber: number;

    /**
     * رابط الفصل الأخير من الكتاب.
     */
    lastChapterApiLink: string;

    /**
     * عدد الآيات التي يحتويها الكتاب.
     */
    totalNumberOfVerses: number;

    /**
     * ما إذا كان الكتاب كتاباً منحولاً.
     * يتم حذفها إذا كانت الترجمة رسمية.
     */
    isApocryphal?: boolean;
}