Ifomethi Ejwayelekile

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

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

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

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

    /**
     * Izixhumanisi zezikhathi zomsindo zezinguqulo ezahlukene zomsindo zesahluko.
     * Isixhumanisi ngasinye sikhomba ifayela lezikhathi zomsindo lalowo mfundi - bheka "Thola Izikhathi Zomsindo Zesahluko" ngezansi.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Isixhumanisi sesahluko esilandelayo.
     * 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 esedlule.
     * 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;

    /**
     * Isixhumanisi sencazelo yezinga lamagama yesahluko.
     * Kushiywe uma isahluko singenazo izichasiselo ezingeni lamagama.
     */
    thisChapterWordsLink?: string;

    /**
     * Isixhumanisi sencazelo yezinga lamagama sesahluko esilandelayo.
     * Akuvunyelwe uma lesi kuyisahluko sokugcina ekuhumusheni, noma uma isahluko esilandelayo singenazo izichasiselo ezingeni lamagama.
     */
    nextChapterWordsLink?: string;

    /**
     * Isixhumanisi sencazelo yezinga lamagama sesahluko esedlule.
     * Akufakiwe uma lesi kuyisahluko sokuqala ekuhumusheni, noma uma isahluko esidlule singenazo izichasiselo ezingeni lamagama.
     */
    previousChapterWordsLink?: string;

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

    /**
     * Isixhumanisi senguqulo elula yalesi sahluko.
     * Akuvunyelwe uma izahluko ezilula zingatholakali.
     */
    simpleChapterApiLink?: string;

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

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

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

    /**
     * Uhlu lwemibhalo yaphansi yesahluko.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Uhlobo lwenyunyana olumelela ingxenye eyodwa yokuqukethwe kwesahluko.
 * Okuqukethwe kwesahluko kungaba ngenye yezinto ezilandelayo:
 * - Isihloko.
 * - Ukuhlukana komugqa.
 * - Ivesi.
 * - Isihlokwana sesiHebheru.
 */
type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

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

    /**
     * Okuqukethwe kwesihloko.
     * Uma izintambo eziningi zifakiwe ku-array, kufanele zihlanganiswe nesikhala.
     */
    content: string[];
}

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

/**
 * Isihlokwana sesiHebheru esahlukweni.
 * Lokhu kuvame ukusetshenziswa njengokuqukethwe kolwazi okuvele emibhalweni yokuqala.
 * Isibonelo, amaHubo 49 anesihloko sesiHebheru esithi "Kumholi wekwaya. IHubo Lamadodana KaKora."
 */
interface ChapterHebrewSubtitle {
    /**
     * Kubonisa ukuthi okuqukethwe kumelela isihlokwana sesiHebheru.
     */
    type: 'hebrew_subtitle';

    /**
     * Uhlu lokuqukethwe oluqukethwe kumbhalo ongezansi.
     * Into ngayinye ohlwini ingaba umucu, umbhalo ofomethiwe, noma ireferensi yaphansi.
     */
    content: (string | FormattedText | VerseFootnoteReference)[];
}

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

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

    /**
     * Uhlu lokuqukethwe kwevesi.
     * Into ngayinye ohlwini ingaba umucu, umbhalo ofomethiwe, noma ireferensi yaphansi.
     */
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

/**
 * Umbhalo ofomethiwe. Okusho ukuthi, umbhalo ofomethiwe ngendlela ethile.
 */
interface FormattedText {
    /**
     * Umbhalo ofomethiwe.
     */
    text: string;

    /**
     * Ukuthi umbhalo umele inkondlo yini.
     * Inombolo ikhombisa izinga lokuhlehlisa.
     *
     * Okuvamile kumaHubo.
     */
    poem?: number;

    /**
     * Ukuthi umbhalo umele yini amazwi kaJesu.
     */
    wordsOfJesus?: boolean;
}

/**
 * Ichaza isikhombimsebenzisi esimele isihloko esifakwe evesini.
 */
interface InlineHeading {
    /**
     * Umbhalo wesihloko.
     */
    heading: string;
}

/**
 * Ichaza isikhombimsebenzisi esimele ukuhlukana komugqa okufakwe evesini.
 */
interface InlineLineBreak {
    lineBreak: true;
}


/**
 * Ireferensi yaphansi evesini noma esihlokweni sesiHebheru.
 */
interface VerseFootnoteReference {
    /**
     * I-ID yenothi.
     */
    noteId: number;
}

/**
 * Ulwazi mayelana nombhalo waphansi.
 */
interface ChapterFootnote {
    /**
     * I-ID yenothi elibhekiselwe kulo.
     */
    noteId: number;

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

    /**
     * Ivesi elibhekisela kumbhalo waphansi.
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * Umshayi wezingcingo okufanele asetshenziswe kumbhalo waphansi.
     * Kuma-footnote, "umshayi wezwi" umlingiswa osetshenziswa embhalweni ukubhekisela kuma-footnote.
     *
     * Isibonelo, embhalweni:
     * Sawubona (a) Mhlaba
     *
     * ---- (a) Lona umbhalo ongezansi.
     *
     * "(a)" ngumshayeli.
     *
     * 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;
}

/**
 * Izixhumanisi zomsindo zesahluko sencwadi.
 */
interface TranslationBookChapterAudioLinks {
    /**
     * Umfundi wesahluko kanye nesixhumanisi se-URL esiya efayeleni lomsindo.
     */
    [reader: string]: string;
}

/**
 * Izikhathi zomsindo zixhumanisa isahluko sencwadi.
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * Umfundi wesahluko kanye nesixhumanisi se-API esiya kufayela lezikhathi zomsindo lalowo mfundi.
     */
    [reader: string]: string;
}

/**
 * Ichaza izikhathi zomsindo zesahluko sencwadi, somfundi oyedwa.
 * Amamephu aya ku-/api/{translation}/{book}/{chapter}.{reader}.audioTimings.json endpoint.
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * I-ID yokuhumusha.
     */
    translationId: string;

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

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

    /**
     * I-ID yomfundi okukhulunywa ngayo kulezi zikhathi.
     */
    reader: string;

    /**
     * Isixhumanisi sefayela lomsindo esilungiselelwe lezi zikhathi.
     */
    audioLink: string;

    /**
     * Isixhumanisi solwazi lwalesi sahluko.
     */
    thisChapterLink: string;

    /**
     * Isixhumanisi solwazi lwesahluko esilandelayo.
     * Akunamsebenzi uma lesi kuyisahluko sokugcina ekuhumusheni.
     */
    nextChapterLink: string | null;

    /**
     * Isixhumanisi solwazi lwesahluko esidlule.
     * Akunamsebenzi uma lesi kuyisahluko sokuqala ekuhunyushweni.
     */
    previousChapterLink: string | null;

    /**
     * Isixhumanisi saleli fayela lezikhathi zomsindo.
     */
    thisChapterAudioTimingsLink: string;

    /**
     * Isixhumanisi sezikhathi zesahluko esilandelayo, somfundi ofanayo.
     * Akunamsebenzi uma lesi kuyisahluko sokugcina ekuhumusheni.
     */
    nextChapterAudioTimingsLink: string | null;

    /**
     * Isixhumanisi sezikhathi zesahluko esedlule, somfundi ofanayo.
     * Akunamsebenzi uma lesi kuyisahluko sokuqala ekuhunyushweni.
     */
    previousChapterAudioTimingsLink: string | null;

    /**
     * Izikhathi ngemizuzwana lapho ivesi ngalinye liqala khona, ngokulandelana.
     * Inombolo yokuqala (uhlu 0) yisikhathi lapho ivesi lokuqala liqala khona ekurekhodweni.
     */
    verses: number[];
}

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

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

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

    /**
     * Isixhumanisi solwazi lwalesi sahluko.
     */
    thisChapterLink: string;

    /**
     * Isixhumanisi solwazi lwesahluko esilandelayo.
     * Akunamsebenzi uma lesi kuyisahluko sokugcina ekuhumusheni.
     */
    nextChapterLink: string | null;

    /**
     * Isixhumanisi solwazi lwesahluko esidlule.
     * Akunamsebenzi uma lesi kuyisahluko sokuqala ekuhunyushweni.
     */
    previousChapterLink: string | null;

    /**
     * Isixhumanisi sefayela lamagama.
     */
    thisChapterWordsLink: string;

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

    /**
     * Isixhumanisi samagama esahluko 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]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * Inkomba yento eqoqweni lokuqukethwe kwevesi okusebenza kulo isichasiselo.
     */
    contentIndex: number;

    /**
     * Inkomba yohlamvu lokuqala lwegama elichaziwe embhalweni wento yokuqukethwe.
     */
    start: number;

    /**
     * Inkomba elandela uhlamvu lokugcina lwegama elichazwe embhalweni wento yokuqukethwe.
     * Okusho ukuthi, i-text.slice(start, end) yigama elichazwe ngenhla.
     */
    end: number;

    /**
     * Inombolo(izinombolo) kaStrong yegama.
     * Kushiywe uma ukuhumusha kunikeze ezinye izichasiselo zegama kuphela.
     */
    strongs?: string[];

    /**
     * Uhlobo lwesichazamazwi (ingcaphuno) saleli gama.
     * Kushiywe ngaphandle uma ukuhumusha kungazange kunikeze.
     */
    lemma?: string;

    /**
     * Ikhodi yokuhlaziya isimo segama.
     * Kushiywe ngaphandle uma ukuhumusha kungazange kunikeze.
     */
    morph?: string;

    /**
     * Isikhombisi segama elisembhalweni womthombo, ngefomethi ethi <sourceName> : <location> .
     * Kushiywe ngaphandle uma ukuhumusha kungazange kunikeze.
     */
    srcloc?: string;

    /**
     * Yikuphi ukuvela kwegama eliyinhloko leli gama. Kususelwa ku-1.
     * Kushiywe ngaphandle uma ukuhumusha kungazange kunikeze.
     */
    occurrence?: number;

    /**
     * Inani eliphelele lezikhathi lapho igama elivela khona.
     * Kushiywe ngaphandle uma ukuhumusha kungazange kunikeze.
     */
    occurrences?: number;
}

/**
 * Ichaza idatha ephelele yokulanda ukuhumusha.
 * Amamephu aya endaweni yokugcina ye-/api/:translationId/complete.json.
 */
export interface TranslationComplete {
    /**
     * I-metadata yokuhumusha.
     */
    translation: Translation;

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

/**
 * Incwadi ekulandisweni okuphelele kokuhumusha.
 */
export interface TranslationCompleteBook {
    /**
     * I-ID yencwadi.
     */
    id: string;

    /**
     * Igama lencwadi elivela enguqulweni.
     */
    name: string;

    /**
     * Igama elivamile lencwadi.
     */
    commonName: string;

    /**
     * Isihloko sencwadi.
     */
    title: string | null;

    /**
     * Ukuhleleka kwencwadi.
     */
    order: number;

    /**
     * Inani lezahluko encwadini.
     */
    numberOfChapters: number;

    /**
     * Inani eliphelele lamavesi encwadini.
     */
    totalNumberOfVerses: number;

    /**
     * Ukuthi le ncwadi ayilona yini iqiniso.
     */
    isApocryphal?: boolean;

    /**
     * Uhlu oluphelele lwezahluko ezinazo zonke izinto eziqukethwe.
     */
    chapters: TranslationCompleteChapter[];
}

/**
 * Isahluko ekulandisweni okuphelele kokuhumusha.
 */
export interface TranslationCompleteChapter {
    /**
     * Inani lamavesi aqukethwe yisahluko.
     */
    numberOfVerses: number;

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

    /**
     * Izikhathi zomsindo (izikhathi zokuqala ngevesi ngalinye, ngemizuzwana) zezinguqulo ezahlukene zomsindo zesahluko.
     *
     * Ngokungafani no `thisChapterAudioTimings` endaweni yokugcina yesahluko ngasinye (exhumanisa ne-"Thola Izikhathi Zomsindo Zesahluko" ngezansi), lokhu kuqukethe izikhathi ngokwazo - njengoba iphuzu lokulanda ukuhumusha okuphelele liwukuba nakho konke kufayela elilodwa.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Isixhumanisi sencazelo yezinga lamagama yesahluko.
     * Kushiywe uma isahluko singenazo izichasiselo ezingeni lamagama.
     */
    thisChapterWordsLink?: string;

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

/**
 * Izikhathi zomsindo zesahluko sencwadi, ezifakwe ngqo esikhundleni sokuxhunywa.
 * Ihlanganisa i-ID yomfundi ohlwini lwezikhathi (ngemizuzwana) lapho ivesi ngalinye liqala khona, ngokulandelana kwevesi.
 */
interface TranslationBookChapterAudioTimingsMap {
    [reader: string]: number[];
}