تنسيق مبسط

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

    /**
     * معلومات الكتاب الخاصة بفصل الكتاب.
     */
    book: TranslationBook;

    /**
     * رابط الفصل الحالي.
     */
    thisChapterLink: string;

    /**
     * الرابط إلى النسخة العادية (غير المبسطة) من هذا الفصل.
     */
    fullChapterApiLink: string;

    /**
     * روابط لإصدارات صوتية مختلفة للفصل.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * روابط التوقيتات الصوتية للإصدارات الصوتية المختلفة للفصل.
     * راجع "الحصول على توقيتات الصوت لفصل ما" في وثائق التنسيق القياسي - ملف التوقيتات هو نفسه بغض النظر عن تنسيق الفصل المرتبط به.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * رابط الفصل التالي، بصيغة مبسطة.
     * لا شيء إذا كان هذا هو الفصل الأخير في الترجمة.
     */
    nextChapterApiLink: string | null;

    /**
     * روابط لإصدارات صوتية مختلفة للفصل التالي.
     * لا شيء إذا كان هذا هو الفصل الأخير في الترجمة.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * روابط التوقيتات الصوتية للإصدارات الصوتية المختلفة للفصل التالي.
     * لا شيء إذا كان هذا هو الفصل الأخير في الترجمة.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * رابط الفصل السابق، بصيغة مبسطة.
     * لا شيء إذا كان هذا هو الفصل الأول في الترجمة.
     */
    previousChapterApiLink: string | null;

    /**
     * روابط لإصدارات صوتية مختلفة للفصل السابق.
     * لا شيء إذا كان هذا هو الفصل الأول في الترجمة.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * روابط التوقيتات الصوتية للإصدارات الصوتية المختلفة للفصل السابق.
     * لا شيء إذا كان هذا هو الفصل الأول في الترجمة.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * عدد الآيات التي يحتويها الفصل.
     */
    numberOfVerses: number;

    /**
     * المعلومات الخاصة بهذا الفصل.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * رقم الفصل.
     */
    number: number;

    /**
     * محتوى الفصل.
     */
    content: SimpleChapterContent[];

    /**
     * قائمة الحواشي التي لم يكن من الممكن ربطها بآية.
     * تُدرج الحواشي التي تنتمي إلى الآية في الآية نفسها، لذا فإن هذه القائمة عادة ما تكون فارغة.
     */
    footnotes: ChapterFootnote[];
}

/**
 * نوع من أنواع الاتحاد يمثل جزءًا واحدًا من المحتوى في فصل مبسط.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * عنوان في فصل.
 */
interface SimpleChapterHeading {
    /**
     * يشير إلى أن المحتوى يمثل عنوانًا.
     */
    type: 'heading';

    /**
     * نص العنوان.
     */
    text: string;
}

/**
 * فاصل أسطر في الفصل.
 */
interface ChapterLineBreak {
    /**
     * يشير إلى أن المحتوى يمثل فاصل أسطر.
     */
    type: 'line_break';
}

/**
 * آية في فصل.
 */
interface SimpleChapterVerse {
    /**
     * يشير ذلك إلى أن المحتوى عبارة عن آية.
     */
    type: 'verse';

    /**
     * رقم الآية.
     */
    number: number;

    /**
     * نص الآية.
     * يتم فصل أبيات الشعر وفواصل الأسطر بواسطة أحرف سطر جديد (\n).
     */
    text: string;

    /**
     * الحواشي التي تظهر في الآية.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * العناوين التي تظهر في منتصف الآية.
     * يتم حذفها إذا لم تحتوي الآية على عناوين داخلية.
     */
    headings?: SimpleInlineHeading[];

    /**
     * نطاقات نص الآية التي تمثل كلمات يسوع.
     * يُحذف إذا لم تحتوي الآية على أي منها.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * نطاقات نص الآية التي تمثل أبيات الشعر.
     * يُحذف إذا لم تحتوي الآية على أي منها.
     */
    poem?: SimplePoemRange[];
}

/**
 * يوجد عنوان فرعي باللغة العبرية في أحد الفصول.
 * غالباً ما يتم تضمين هذه المعلومات كمحتوى إعلامي ظهر في المخطوطات الأصلية.
 * فعلى سبيل المثال، يحتوي المزمور 49 على العنوان الفرعي العبري "إلى قائد الجوقة. مزمور لبني قورح".
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * يشير هذا إلى أن المحتوى يمثل ترجمة عبرية.
     */
    type: 'hebrew_subtitle';
}

/**
 * حاشية في بيت شعري.
 */
interface SimpleVerseFootnote {
    /**
     * رقم تعريف المذكرة.
     */
    noteId: number;

    /**
     * الفهرس في نص الآية الذي يجب إدراج مرجع الحاشية عنده.
     */
    offset: number;

    /**
     * نص الحاشية.
     */
    text: string;

    /**
     * المتصل الذي ينبغي استخدامه للحاشية السفلية.
     * إذا كانت القيمة "+"، فيجب إنشاء المتصل تلقائيًا.
     * إذا كانت القيمة فارغة، فيجب أن يكون المتصل فارغًا.
     * إذا كانت سلسلة نصية، فيجب أن يكون المتصل هو تلك السلسلة النصية.
     */
    caller: '+' | string | null;
}

/**
 * عنوان مُضمّن في بيت شعري.
 */
interface SimpleInlineHeading {
    /**
     * الرقم الموجود في نص الآية الذي يظهر فيه العنوان.
     */
    offset: number;

    /**
     * نص العنوان.
     */
    text: string;
}

/**
 * مجموعة من النصوص داخل بيت شعري.
 */
interface SimpleTextRange {
    /**
     * فهرس الحرف الأول من النطاق.
     */
    start: number;

    /**
     * الفهرس الذي يلي الحرف الأخير من النطاق.
     */
    end: number;
}

/**
 * مجموعة من النصوص داخل بيت شعري تمثل سطراً من الشعر.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * مستوى المسافة البادئة التي يجب عرض سطر الشعر بها.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * معرّف الترجمة.
     */
    translationId: string;

    /**
     * رقم تعريف الكتاب.
     */
    bookId: string;

    /**
     * رقم الفصل.
     */
    chapterNumber: number;

    /**
     * الرابط إلى الفصل المبسط الذي تُخصص له هذه التعليقات.
     */
    thisChapterLink: string;

    /**
     * الرابط إلى الفصل المبسط التالي.
     * لا شيء إذا كان هذا هو الفصل الأخير في الترجمة.
     */
    nextChapterLink: string | null;

    /**
     * الرابط إلى الفصل المبسط السابق.
     * لا شيء إذا كان هذا هو الفصل الأول في الترجمة.
     */
    previousChapterLink: string | null;

    /**
     * الرابط إلى هذه التعليقات التوضيحية.
     */
    thisChapterWordsLink: string;

    /**
     * رابط التعليقات التوضيحية للفصل التالي.
     * قيمة فارغة إذا كان هذا هو الفصل الأخير في الترجمة، أو إذا لم يكن للفصل التالي أي تعليقات على مستوى الكلمات.
     */
    nextChapterWordsLink: string | null;

    /**
     * رابط التعليقات التوضيحية للفصل السابق.
     * قيمة فارغة إذا كان هذا هو الفصل الأول في الترجمة، أو إذا لم يكن للفصل السابق أي تعليقات على مستوى الكلمات.
     */
    previousChapterWordsLink: string | null;

    /**
     * الكلمات المشروحة لكل آية في الفصل، مرتبة حسب رقم الآية.
     * كل قائمة مرتبة حسب ترتيب ورود الكلمات في الآية.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * شرح تفصيلي على مستوى الكلمات في فصل مبسط.
 */
export interface SimpleChapterWord {
    /**
     * فهرس الحرف الأول من الكلمة المشروحة في نص الآية.
     */
    start: number;

    /**
     * الفهرس الذي يلي الحرف الأخير من الكلمة المشروحة في نص الآية.
     */
    end: number;

    /**
     * أرقام سترونغ للكلمة.
     */
    strongs?: string[];

    /**
     * الجذر اللغوي (الشكل المعجمي) للكلمة في اللغة المصدر.
     */
    lemma?: string;

    /**
     * مورفولوجيا الكلمة في اللغة المصدر.
     */
    morph?: string;

    /**
     * موقع الكلمة في النص الأصلي.
     */
    srcloc?: string;

    /**
     * أي موضع وردت فيه هذه الكلمة في الآية؟
     */
    occurrence?: number;

    /**
     * عدد مرات ورود الكلمة في الآية.
     */
    occurrences?: number;
}

/**
 * يحدد بيانات تنزيل الترجمة الكاملة، باستخدام تنسيق الفصل المبسط.
 * يتم الربط بنقطة النهاية /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * بيانات الترجمة الوصفية.
     */
    translation: Translation;

    /**
     * القائمة الكاملة للكتب مع جميع فصولها.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * كتاب مترجم بالكامل، قابل للتحميل، باستخدام تنسيق الفصول المبسط.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * القائمة الكاملة للفصول مع جميع محتوياتها.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * فصل من الترجمة الكاملة القابلة للتنزيل، باستخدام تنسيق الفصل المبسط.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * عدد الآيات التي يحتويها الفصل.
     */
    numberOfVerses: number;

    /**
     * روابط لإصدارات صوتية مختلفة للفصل.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * توقيتات الصوت (أوقات بدء كل مقطع، بالثواني) للفصل.
     *
     * لاحظ أن ملفات الترجمة الكاملة تحتوي على التوقيتات نفسها (انظر TranslationBookChapterAudioTimingsMap في وثائق التنسيق القياسي)، على عكس نقاط نهاية الفصول الفردية، والتي تحتوي على روابط إليها.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * رابطٌ إلى شروح الكلمات في الفصل، باستخدام الصيغة المبسطة. يُحذف هذا الرابط إذا لم يكن للفصل أي شروح على مستوى الكلمات.
     */
    thisChapterWordsLink?: string;

    /**
     * المعلومات المبسطة للفصل.
     */
    chapter: SimpleChapterData;
}