Vereenvoudigde Formaat

export interface SimpleTranslationBookChapter {
    /**
     * Die vertaalinligting vir die boekhoofstuk.
     */
    translation: Translation;

    /**
     * Die boekinligting vir die boekhoofstuk.
     */
    book: TranslationBook;

    /**
     * Die skakel na die huidige hoofstuk.
     */
    thisChapterLink: string;

    /**
     * Die skakel na die gewone (nie-vereenvoudigde) weergawe van hierdie hoofstuk.
     */
    fullChapterApiLink: string;

    /**
     * Die skakels na verskillende oudioweergawes vir die hoofstuk.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Die skakels na die oudio-tye vir verskillende oudio-weergawes vir die hoofstuk.
     * Sien "Kry die oudio-tydsberekening vir 'n hoofstuk" in die standaardformaatdokumentasie - die tydsberekeninglêer is dieselfde ongeag watter hoofstukformaat daaraan gekoppel is.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Die skakel na die volgende hoofstuk, in die vereenvoudigde formaat.
     * Nul as dit die laaste hoofstuk in die vertaling is.
     */
    nextChapterApiLink: string | null;

    /**
     * Die skakels na verskillende oudioweergawes vir die volgende hoofstuk.
     * Nul as dit die laaste hoofstuk in die vertaling is.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Die skakels na die oudio-tye vir verskillende oudio-weergawes vir die volgende hoofstuk.
     * Nul as dit die laaste hoofstuk in die vertaling is.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Die skakel na die vorige hoofstuk, in die vereenvoudigde formaat.
     * Nul as dit die eerste hoofstuk in die vertaling is.
     */
    previousChapterApiLink: string | null;

    /**
     * Die skakels na verskillende oudioweergawes vir die vorige hoofstuk.
     * Nul as dit die eerste hoofstuk in die vertaling is.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Die skakels na die oudio-tye vir verskillende oudio-weergawes vir die vorige hoofstuk.
     * Nul as dit die eerste hoofstuk in die vertaling is.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Die aantal verse wat die hoofstuk bevat.
     */
    numberOfVerses: number;

    /**
     * Die inligting vir die hoofstuk.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * Die nommer van die hoofstuk.
     */
    number: number;

    /**
     * Die inhoud van die hoofstuk.
     */
    content: SimpleChapterContent[];

    /**
     * Die lys van voetnotas wat nie met 'n vers geassosieer kon word nie.
     * Voetnotas wat aan 'n vers behoort, word op die vers self ingesluit, dus is hierdie lys gewoonlik leeg.
     */
    footnotes: ChapterFootnote[];
}

/**
 * 'n Unietipe wat 'n enkele stuk inhoud in 'n vereenvoudigde hoofstuk verteenwoordig.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * 'n Opskrif in 'n hoofstuk.
 */
interface SimpleChapterHeading {
    /**
     * Dui aan dat die inhoud 'n opskrif verteenwoordig.
     */
    type: 'heading';

    /**
     * Die teks van die opskrif.
     */
    text: string;
}

/**
 * 'n Lynbreuk in 'n hoofstuk.
 */
interface ChapterLineBreak {
    /**
     * Dui aan dat die inhoud 'n reëlbreuk verteenwoordig.
     */
    type: 'line_break';
}

/**
 * 'n Vers in 'n hoofstuk.
 */
interface SimpleChapterVerse {
    /**
     * Dui aan dat die inhoud 'n vers is.
     */
    type: 'verse';

    /**
     * Die nommer van die vers.
     */
    number: number;

    /**
     * Die teks van die vers.
     * Reëls van gedigte en reëlbreuke word geskei deur reëlnuu (\n) karakters.
     */
    text: string;

    /**
     * Die voetnotas wat in die vers voorkom.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Die opskrifte wat in die middel van die vers voorkom.
     * Weglaat indien die vers geen inlynopskrifte bevat nie.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Die reekse van die vers teks wat die Woorde van Jesus verteenwoordig.
     * Weglaat as die vers niks bevat nie.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Die reekse van die vers teks wat poësiereëls verteenwoordig.
     * Weglaat as die vers niks bevat nie.
     */
    poem?: SimplePoemRange[];
}

/**
 * 'n Hebreeuse ondertitel in 'n hoofstuk.
 * Dit word dikwels ingesluit as inligtingsinhoud wat in die oorspronklike manuskripte verskyn het.
 * Byvoorbeeld, Psalm 49 het die Hebreeuse subtitel "Vir die koorleier. 'n Psalm van die seuns van Korag."
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Dui aan dat die inhoud 'n Hebreeuse ondertitel verteenwoordig.
     */
    type: 'hebrew_subtitle';
}

/**
 * 'n Voetnoot in 'n vers.
 */
interface SimpleVerseFootnote {
    /**
     * Die ID van die nota.
     */
    noteId: number;

    /**
     * Die indeks in die versteks waar die voetnootoproeper ingevoeg moet word.
     */
    offset: number;

    /**
     * Die teks van die voetnoot.
     */
    text: string;

    /**
     * Die oproeper wat vir die voetnoot gebruik moet word.
     * Indien "+", dan moet die oproeper outomaties gegenereer word.
     * Indien nul, dan moet die oproeper leeg wees.
     * Indien 'n string, dan moet die oproeper daardie string wees.
     */
    caller: '+' | string | null;
}

/**
 * 'n Opskrif wat in 'n vers ingebed is.
 */
interface SimpleInlineHeading {
    /**
     * Die indeks in die versteks waar die opskrif voorkom.
     */
    offset: number;

    /**
     * Die teks van die opskrif.
     */
    text: string;
}

/**
 * 'n Teksreeks binne 'n vers.
 */
interface SimpleTextRange {
    /**
     * Die indeks van die eerste karakter van die reeks.
     */
    start: number;

    /**
     * Die indeks na die laaste karakter van die reeks.
     */
    end: number;
}

/**
 * 'n Teksreeks binne 'n vers wat 'n poësiereël verteenwoordig.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Die vlak van inspringing waarmee die poësiereël vertoon moet word.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * Die ID van die vertaling.
     */
    translationId: string;

    /**
     * Die ID van die boek.
     */
    bookId: string;

    /**
     * Die nommer van die hoofstuk.
     */
    chapterNumber: number;

    /**
     * Die skakel na die vereenvoudigde hoofstuk waarvoor hierdie aantekeninge is.
     */
    thisChapterLink: string;

    /**
     * Die skakel na die volgende vereenvoudigde hoofstuk.
     * Nul as dit die laaste hoofstuk in die vertaling is.
     */
    nextChapterLink: string | null;

    /**
     * Die skakel na die vorige vereenvoudigde hoofstuk.
     * Nul as dit die eerste hoofstuk in die vertaling is.
     */
    previousChapterLink: string | null;

    /**
     * Die skakel na hierdie aantekeninge.
     */
    thisChapterWordsLink: string;

    /**
     * Die skakel na die aantekeninge vir die volgende hoofstuk.
     * Nul as dit die laaste hoofstuk in die vertaling is, of as die volgende hoofstuk geen woordvlak-aantekeninge het nie.
     */
    nextChapterWordsLink: string | null;

    /**
     * Die skakel na die aantekeninge vir die vorige hoofstuk.
     * Nul as dit die eerste hoofstuk in die vertaling is, of as die vorige hoofstuk geen woordvlak-aantekeninge het nie.
     */
    previousChapterWordsLink: string | null;

    /**
     * Die geannoteerde woorde vir elke vers in die hoofstuk, gerangskik volgens versnommer.
     * Elke lys is in die volgorde waarin die woorde in die vers voorkom.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * 'n Woordvlak-annotasie in 'n vereenvoudigde hoofstuk.
 */
export interface SimpleChapterWord {
    /**
     * Die indeks van die eerste karakter van die geannoteerde woord in die versteks.
     */
    start: number;

    /**
     * Die indeks na die laaste karakter van die geannoteerde woord in die versteks.
     */
    end: number;

    /**
     * Die Strong se getalle vir die woord.
     */
    strongs?: string[];

    /**
     * Die lemma (woordeboekvorm) van die woord in die brontaal.
     */
    lemma?: string;

    /**
     * Die morfologie van die woord in die brontaal.
     */
    morph?: string;

    /**
     * Die ligging van die woord in die bronteks.
     */
    srcloc?: string;

    /**
     * Watter voorkoms van die woord in die vers is dit.
     */
    occurrence?: number;

    /**
     * Die aantal kere wat die woord in die vers voorkom.
     */
    occurrences?: number;
}

/**
 * Definieer die volledige vertaling-aflaaidata, met behulp van die vereenvoudigde hoofstukformaat.
 * Kaarteer na die /api/:translationId/complete.simple.json eindpunt.
 */
export interface SimpleTranslationComplete {
    /**
     * Die vertalingsmetadata.
     */
    translation: Translation;

    /**
     * Die volledige lys van boeke met al hul hoofstukke.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * 'n Boek in die volledige vertaling aflaai, met behulp van die vereenvoudigde hoofstukformaat.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * Die volledige lys van hoofstukke met alle inhoud.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * 'n Hoofstuk in die volledige vertaling-aflaai, met behulp van die vereenvoudigde hoofstukformaat.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * Die aantal verse wat die hoofstuk bevat.
     */
    numberOfVerses: number;

    /**
     * Die skakels na verskillende oudioweergawes vir die hoofstuk.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Die oudio-tydsberekening (begintye per vers, in sekondes) vir die hoofstuk.
     *
     * Let daarop dat die volledige vertaallêers die tydsberekening self bevat (sien TranslationBookChapterAudioTimingsMap in die standaardformaatdokumente), anders as die individuele hoofstuk-eindpunte, wat skakels daarna bevat.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Die skakel na die woordvlak-aantekeninge vir die hoofstuk, met behulp van die vereenvoudigde formaat. Weglaat as die hoofstuk geen woordvlak-aantekeninge het nie.
     */
    thisChapterWordsLink?: string;

    /**
     * Die vereenvoudigde inligting vir die hoofstuk.
     */
    chapter: SimpleChapterData;
}