Ifomethi Elula

export interface SimpleTranslationBookChapter {
    /**
     * Ulwazi lokuhumusha lwesahluko sencwadi.
     */
    translation: Translation;

    /**
     * Ulwazi lwencwadi lwesahluko sencwadi.
     */
    book: TranslationBook;

    /**
     * Isixhumanisi sesahluko samanje.
     */
    thisChapterLink: string;

    /**
     * Isixhumanisi senguqulo evamile (engelula) yalesi sahluko.
     */
    fullChapterApiLink: string;

    /**
     * Izixhumanisi zezinguqulo ezahlukene zomsindo zesahluko.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Izixhumanisi zezikhathi zomsindo zezinguqulo ezahlukene zomsindo zesahluko.
     * Bheka "Thola Izikhathi Zomsindo Zesahluko" kumadokhumenti efomethi ejwayelekile - ifayela lezikhathi liyafana kungakhathaliseki ukuthi iyiphi ifomethi yesahluko exhunywe kulo.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Isixhumanisi sesahluko esilandelayo, ngefomethi elula.
     * Akunamsebenzi uma lesi kuyisahluko sokugcina ekuhumusheni.
     */
    nextChapterApiLink: string | null;

    /**
     * Izixhumanisi zezinguqulo ezahlukene zomsindo zesahluko esilandelayo.
     * Akunamsebenzi uma lesi kuyisahluko sokugcina ekuhumusheni.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Izixhumanisi zezikhathi zomsindo zezinguqulo ezahlukene zomsindo zesahluko esilandelayo.
     * Akunamsebenzi uma lesi kuyisahluko sokugcina ekuhumusheni.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Isixhumanisi sesahluko esidlule, ngefomethi elula.
     * Akunamsebenzi uma lesi kuyisahluko sokuqala ekuhunyushweni.
     */
    previousChapterApiLink: string | null;

    /**
     * Izixhumanisi zezinguqulo ezahlukene zomsindo zesahluko esedlule.
     * Akunamsebenzi uma lesi kuyisahluko sokuqala ekuhunyushweni.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Izixhumanisi zezikhathi zomsindo zezinguqulo ezahlukene zomsindo zesahluko esedlule.
     * Akunamsebenzi uma lesi kuyisahluko sokuqala ekuhunyushweni.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Inani lamavesi aqukethwe yisahluko.
     */
    numberOfVerses: number;

    /**
     * Ulwazi lwesahluko.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * Inombolo yesahluko.
     */
    number: number;

    /**
     * Okuqukethwe kwesahluko.
     */
    content: SimpleChapterContent[];

    /**
     * Uhlu lwemibhalo yaphansi engenakuhlotshaniswa nevesi.
     * Imibhalo yaphansi eyingxenye yevesi ifakiwe evesini ngokwalo, ngakho-ke lolu hlu luvame ukuba lungenalutho.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Uhlobo lwenhlangano olumelela ingxenye eyodwa yokuqukethwe esahlukweni esilula.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Isihloko esahlukweni.
 */
interface SimpleChapterHeading {
    /**
     * Kubonisa ukuthi okuqukethwe kumele isihloko.
     */
    type: 'heading';

    /**
     * Umbhalo wesihloko.
     */
    text: string;
}

/**
 * Ukuhlukana komugqa esahlukweni.
 */
interface ChapterLineBreak {
    /**
     * Kubonisa ukuthi okuqukethwe kumele ukuhlukana komugqa.
     */
    type: 'line_break';
}

/**
 * Ivesi esahlukweni.
 */
interface SimpleChapterVerse {
    /**
     * Kubonisa ukuthi okuqukethwe kuyivesi.
     */
    type: 'verse';

    /**
     * Inombolo yevesi.
     */
    number: number;

    /**
     * Umbhalo wevesi.
     * Imigqa yezinkondlo kanye nokuhlukana kwemigqa kuhlukaniswa ngabalingiswa bomugqa omusha (\n).
     */
    text: string;

    /**
     * Imibhalo yaphansi evela evesini.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Izihloko ezivela phakathi nevesi.
     * Akuvunyelwe uma ivesi lingenazo izihloko eziqondile.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Izinga lombhalo wamavesi amelela amazwi kaJesu.
     * Kushiywe uma ivesi lingenalo nhlobo.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Izinga lombhalo wevesi elimelela imigqa yezinkondlo.
     * Kushiywe uma ivesi lingenalo nhlobo.
     */
    poem?: SimplePoemRange[];
}

/**
 * Isihlokwana sesiHebheru esahlukweni.
 * Lokhu kuvame ukufakwa njengokuqukethwe kolwazi okuvele emibhalweni yokuqala.
 * Isibonelo, amaHubo 49 anesihloko sesiHebheru esithi "Kumholi wekwaya. IHubo Lamadodana KaKora."
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Kubonisa ukuthi okuqukethwe kumelela isihlokwana sesiHebheru.
     */
    type: 'hebrew_subtitle';
}

/**
 * Umbhalo waphansi evesini.
 */
interface SimpleVerseFootnote {
    /**
     * I-ID yenothi.
     */
    noteId: number;

    /**
     * Inkomba embhalweni wevesi okufanele ifakwe kuyo umuntu obiza umbhalo waphansi.
     */
    offset: number;

    /**
     * Umbhalo wombhalo waphansi.
     */
    text: string;

    /**
     * Umshayi wezingcingo okufanele asetshenziswe kumbhalo waphansi.
     * Uma "+", khona-ke umuntu oshaya ucingo kufanele azenzekele.
     * Uma kungekho lutho, khona-ke umuntu oshaya ucingo kufanele angabi nalutho.
     * Uma kuyintambo, khona-ke umuntu obizayo kufanele abe yintambo leyo.
     */
    caller: '+' | string | null;
}

/**
 * Isihloko esifakwe evesini.
 */
interface SimpleInlineHeading {
    /**
     * Inkomba embhalweni wevesi lapho isihloko sivela khona.
     */
    offset: number;

    /**
     * Umbhalo wesihloko.
     */
    text: string;
}

/**
 * Uhlu lombhalo ngaphakathi kwevesi.
 */
interface SimpleTextRange {
    /**
     * Inkomba yohlamvu lokuqala lobubanzi.
     */
    start: number;

    /**
     * Inkomba ngemva kohlamvu lokugcina lobubanzi.
     */
    end: number;
}

/**
 * Uhlu lombhalo ngaphakathi kwevesi elimelela umugqa wezinkondlo.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Izinga lokuzinza okufanele kuboniswe ngalo umugqa wezinkondlo.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * I-ID yokuhumusha.
     */
    translationId: string;

    /**
     * I-ID yencwadi.
     */
    bookId: string;

    /**
     * Inombolo yesahluko.
     */
    chapterNumber: number;

    /**
     * Isixhumanisi sesahluko esenziwe lula esilungiselelwe lezi zichasiselo.
     */
    thisChapterLink: string;

    /**
     * Isixhumanisi sesahluko esilandelayo esenziwe lula.
     * Akunamsebenzi uma lesi kuyisahluko sokugcina ekuhumusheni.
     */
    nextChapterLink: string | null;

    /**
     * Isixhumanisi sesahluko esenziwe lula esedlule.
     * Akunamsebenzi uma lesi kuyisahluko sokuqala ekuhunyushweni.
     */
    previousChapterLink: string | null;

    /**
     * Isixhumanisi salezi zichasiselo.
     */
    thisChapterWordsLink: string;

    /**
     * Isixhumanisi sencazelo yesahluko esilandelayo.
     * Akunamsebenzi uma lesi kuyisahluko sokugcina ekuhumusheni, noma uma isahluko esilandelayo singenazo izichasiselo ezingeni lamagama.
     */
    nextChapterWordsLink: string | null;

    /**
     * Isixhumanisi sencazelo yesahluko esedlule.
     * Akunamsebenzi uma lesi kuyisahluko sokuqala ekuhumusheni, noma uma isahluko esidlule singenazo izichasiselo ezingeni lamagama.
     */
    previousChapterWordsLink: string | null;

    /**
     * Amagama anezichasiselo zevesi ngalinye esahlukweni, afakwe uphawu lwenombolo yevesi.
     * Uhlu ngalunye lulandelana ngendlela amagama avela ngayo evesini.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Isichasiselo sezinga lamagama esahlukweni esilula.
 */
export interface SimpleChapterWord {
    /**
     * Inkomba yohlamvu lokuqala lwegama elichazwe embhalweni wevesi.
     */
    start: number;

    /**
     * Inkomba elandela uhlamvu lokugcina lwegama elichazwe embhalweni wevesi.
     */
    end: number;

    /**
     * Izinombolo zikaStrong zegama.
     */
    strongs?: string[];

    /**
     * I-lemma (isichazamazwi) segama olimini lomthombo.
     */
    lemma?: string;

    /**
     * Ukwakheka kwegama olimini oluvela kulo.
     */
    morph?: string;

    /**
     * Indawo yegama embhalweni womthombo.
     */
    srcloc?: string;

    /**
     * Yikuphi ukuvela kwegama evesini lokhu.
     */
    occurrence?: number;

    /**
     * Inani lezikhathi lapho leli gama livela khona evesini.
     */
    occurrences?: number;
}

/**
 * Ichaza idatha ephelele yokulanda ukuhumusha, isebenzisa ifomethi yesahluko esenziwe lula.
 * Amamephu aya endaweni yokugcina ye-/api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * I-metadata yokuhumusha.
     */
    translation: Translation;

    /**
     * Uhlu oluphelele lwezincwadi nazo zonke izahluko zazo.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Incwadi ehunyushwe ngokuphelele, kusetshenziswa ifomethi yezahluko elula.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * Uhlu oluphelele lwezahluko ezinazo zonke izinto eziqukethwe.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Isahluko esiku-download ephelele yokuhumusha, kusetshenziswa ifomethi yesahluko esenziwe lula.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * Inani lamavesi aqukethwe yisahluko.
     */
    numberOfVerses: number;

    /**
     * Izixhumanisi zezinguqulo ezahlukene zomsindo zesahluko.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Izikhathi zomsindo (izikhathi zokuqala ngevesi ngalinye, ngemizuzwana) zesahluko.
     *
     * Qaphela ukuthi amafayela okuhumusha aphelele aqukethe izikhathi ngokwazo (bheka i-TranslationBookChapterAudioTimingsMap kumadokhumenti efomethi ejwayelekile), ngokungafani nama-endpoints esahluko ngasinye, aqukethe izixhumanisi eziya kuwo.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Isixhumanisi esiya ezichasisweni zezinga lamagama zesahluko, kusetshenziswa ifomethi elula. Asifakwanga uma isahluko singenazo izichasiso zezinga lamagama.
     */
    thisChapterWordsLink?: string;

    /**
     * Ulwazi olulula lwesahluko.
     */
    chapter: SimpleChapterData;
}