Tsarin da aka Sauƙaƙa

export interface SimpleTranslationBookChapter {
    /**
     * Bayanin fassarar babin littafin.
     */
    translation: Translation;

    /**
     * Bayanin littafin don babin littafin.
     */
    book: TranslationBook;

    /**
     * Haɗin zuwa babi na yanzu.
     */
    thisChapterLink: string;

    /**
     * Hanyar haɗi zuwa sigar da aka saba (ba a sauƙaƙa ba) ta wannan babi.
     */
    fullChapterApiLink: string;

    /**
     * Hanyoyin haɗi zuwa nau'ikan sauti daban-daban don babin.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Hanyoyin haɗi zuwa lokutan sauti don nau'ikan sauti daban-daban na babin.
     * Duba "Sami Lokutan Sauti don Babi" a cikin takaddun tsari na yau da kullun - fayil ɗin lokaci iri ɗaya ne ba tare da la'akari da tsarin babi da aka haɗa shi ba.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Hanyar haɗi zuwa babi na gaba, a cikin tsarin da aka sauƙaƙe.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterApiLink: string | null;

    /**
     * Hanyoyin haɗi zuwa nau'ikan sauti daban-daban don babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Hanyoyin haɗi zuwa lokutan sauti don nau'ikan sauti daban-daban don babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Hanyar haɗi zuwa babi na baya, a cikin tsarin da aka sauƙaƙe.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterApiLink: string | null;

    /**
     * Hanyoyin haɗi zuwa nau'ikan sauti daban-daban na babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Hanyoyin haɗi zuwa lokutan sauti don nau'ikan sauti daban-daban na babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Adadin ayoyin da surar ta kunsa.
     */
    numberOfVerses: number;

    /**
     * Bayanin da aka bayar don babi.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * Adadin babin.
     */
    number: number;

    /**
     * Abubuwan da ke cikin babin.
     */
    content: SimpleChapterContent[];

    /**
     * Jerin bayanan ƙasa waɗanda ba za a iya danganta su da aya ba.
     * An haɗa bayanan ƙasa waɗanda suke cikin aya a cikin ayar, don haka wannan jerin yawanci babu komai a ciki.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Nau'in haɗin gwiwa wanda ke wakiltar wani yanki guda na abun ciki a cikin babi mai sauƙi.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Kan magana a cikin wani babi.
 */
interface SimpleChapterHeading {
    /**
     * Yana nuna cewa abubuwan da ke ciki suna wakiltar wani taken.
     */
    type: 'heading';

    /**
     * Rubutun kanun.
     */
    text: string;
}

/**
 * Rage layi a cikin babi.
 */
interface ChapterLineBreak {
    /**
     * Yana nuna cewa abubuwan da ke ciki suna wakiltar karya layi.
     */
    type: 'line_break';
}

/**
 * Aya a cikin babi.
 */
interface SimpleChapterVerse {
    /**
     * Yana nuna cewa abin da ke ciki aya ce.
     */
    type: 'verse';

    /**
     * Adadin ayar.
     */
    number: number;

    /**
     * Nassin ayar.
     * Layukan waƙoƙi da ragowar layi an raba su da haruffan sabon layi (\n).
     */
    text: string;

    /**
     * Bayanan da suka bayyana a cikin ayar.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Kanun da suka bayyana a tsakiyar baitin.
     * An cire shi idan bai ƙunshi kanun labarai a layi ba.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Jerin ayar da ke wakiltar Kalmomin Yesu.
     * An yi watsi da shi idan ayar ba ta ƙunshi komai ba.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Jerin rubutun baiti da ke wakiltar layukan wakoki.
     * An yi watsi da shi idan ayar ba ta ƙunshi komai ba.
     */
    poem?: SimplePoemRange[];
}

/**
 * Subtitle na Ibrananci a cikin babi.
 * Sau da yawa ana haɗa waɗannan a matsayin abubuwan da ke cikin bayanai waɗanda suka bayyana a cikin rubuce-rubucen asali.
 * Misali, Zabura ta 49 tana da taken Ibrananci "Ga shugaban mawaƙa. Zabura ta 'Ya'yan Kora."
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Yana nuna cewa abubuwan da ke ciki suna wakiltar Subtitle na Ibrananci.
     */
    type: 'hebrew_subtitle';
}

/**
 * Bayanin ƙasa a cikin aya.
 */
interface SimpleVerseFootnote {
    /**
     * ID na takardar.
     */
    noteId: number;

    /**
     * Fihirisar da ke cikin rubutun baitin da ya kamata a saka a ƙasan bayanin da ke cikinsa.
     */
    offset: number;

    /**
     * Rubutun ƙasan ƙasa.
     */
    text: string;

    /**
     * Mai kiran da ya kamata a yi amfani da shi don yin amfani da ƙasidar ƙasa.
     * Idan "+" ne, to ya kamata a ƙirƙiri mai kiran ta atomatik.
     * Idan babu komai, to mai kiran ya kamata ya zama babu komai.
     * Idan igiya ce, to mai kiran ya kamata ya zama igiyar.
     */
    caller: '+' | string | null;
}

/**
 * Kanun da aka saka a cikin aya.
 */
interface SimpleInlineHeading {
    /**
     * Fihirisar da ke cikin rubutun ayar da taken ya bayyana a.
     */
    offset: number;

    /**
     * Rubutun kanun.
     */
    text: string;
}

/**
 * Jerin rubutu a cikin aya.
 */
interface SimpleTextRange {
    /**
     * Fihirisar harafin farko na zangon.
     */
    start: number;

    /**
     * Fihirisar bayan harafin ƙarshe na zangon.
     */
    end: number;
}

/**
 * Jerin rubutu a cikin baiti wanda ke wakiltar layin waƙa.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Matakin da ya kamata a nuna layin waƙar da shi.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * ID na fassarar.
     */
    translationId: string;

    /**
     * ID na littafin.
     */
    bookId: string;

    /**
     * Adadin babin.
     */
    chapterNumber: number;

    /**
     * Haɗin zuwa babi mai sauƙi wanda waɗannan bayanan suka kasance don.
     */
    thisChapterLink: string;

    /**
     * Hanyar haɗi zuwa babi mai sauƙi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterLink: string | null;

    /**
     * Hanyar haɗi zuwa babin da aka sauƙaƙa a baya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterLink: string | null;

    /**
     * Haɗin zuwa waɗannan bayanan.
     */
    thisChapterWordsLink: string;

    /**
     * Hanyar haɗi zuwa bayanin da ke ƙasa don babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar, ko kuma idan babi na gaba ba shi da wani bayani na matakin kalma.
     */
    nextChapterWordsLink: string | null;

    /**
     * Hanyar haɗi zuwa bayanin da aka bayar a babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar, ko kuma idan babi na baya ba shi da wani bayani na matakin kalma.
     */
    previousChapterWordsLink: string | null;

    /**
     * Kalmomin da aka rubuta a cikin kowace aya a cikin surar, waɗanda aka manne da lambar aya.
     * Kowanne jeri yana cikin tsarin da kalmomin suka bayyana a cikin ayar.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Bayanin matakin kalma a cikin babi mai sauƙi.
 */
export interface SimpleChapterWord {
    /**
     * Fihirisar harafin farko na kalmar da aka yi wa alama a cikin rubutun ayar.
     */
    start: number;

    /**
     * Fihirisar da ke bayan harafin ƙarshe na kalmar da aka yi wa alama a cikin rubutun baitin.
     */
    end: number;

    /**
     * Lambobin Ƙarfi don kalmar.
     */
    strongs?: string[];

    /**
     * Kalmar lemma (siffar ƙamus) a cikin harshen tushe.
     */
    lemma?: string;

    /**
     * Tsarin kalmar a cikin harshen tushe.
     */
    morph?: string;

    /**
     * Wurin da kalmar take a cikin rubutun tushe.
     */
    srcloc?: string;

    /**
     * Wace irin aukuwar kalmar a cikin ayar ce wannan.
     */
    occurrence?: number;

    /**
     * Adadin sau da kalmar ta bayyana a cikin ayar.
     */
    occurrences?: number;
}

/**
 * Yana bayyana cikakken bayanan saukar da fassarar, ta amfani da tsarin babi mai sauƙi.
 * Taswirori zuwa ƙarshen /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * Bayanan fassarar.
     */
    translation: Translation;

    /**
     * Cikakken jerin littattafai tare da dukkan surori.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Sauke littafi a cikin cikakken fassarar, ta amfani da tsarin babi mai sauƙi.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * Cikakken jerin surori tare da duk abubuwan da ke ciki.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Babi a cikin cikakken fassarar da aka sauke, ta amfani da tsarin babi mai sauƙi.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * Adadin ayoyin da surar ta kunsa.
     */
    numberOfVerses: number;

    /**
     * Hanyoyin haɗi zuwa nau'ikan sauti daban-daban don babin.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Lokacin sauti (lokacin farawa a kowace aya, cikin daƙiƙa) na babin.
     *
     * Lura cewa cikakkun fayilolin fassarar suna ɗauke da lokutan da kansu (duba TranslationBookChapterAudioTimingsMap a cikin takaddun tsari na yau da kullun), sabanin ƙarshen babi na mutum ɗaya, wanda ke ɗauke da hanyoyin haɗi zuwa gare su.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Hanyar haɗi zuwa bayanin matakin kalma don babin, ta amfani da tsarin da aka sauƙaƙe. An cire shi idan babin ba shi da bayanin matakin kalma.
     */
    thisChapterWordsLink?: string;

    /**
     * Bayanin da aka sauƙaƙa don babin.
     */
    chapter: SimpleChapterData;
}