Standaardformaat

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

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

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

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

    /**
     * Die skakels na die oudio-tye vir verskillende oudio-weergawes vir die hoofstuk.
     * Elke skakel wys na die oudio-tydsberekeninglêer vir daardie leser - sien "Kry die oudio-tydsberekeninge vir 'n hoofstuk" hieronder.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Die skakel na die volgende hoofstuk.
     * 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.
     * 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 skakel na die woordvlak-annotasies vir die hoofstuk.
     * Weglaat indien die hoofstuk geen woordvlak-aantekeninge het nie.
     */
    thisChapterWordsLink?: string;

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

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

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

    /**
     * Die skakel na die vereenvoudigde weergawe van hierdie hoofstuk.
     * Weglaat indien vereenvoudigde hoofstukke nie beskikbaar is nie.
     */
    simpleChapterApiLink?: string;

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

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

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

    /**
     * Die lys van voetnotas vir die hoofstuk.
     */
    footnotes: ChapterFootnote[];
}

/**
 * 'n Unietipe wat 'n enkele stuk hoofstukinhoud verteenwoordig.
 * 'n Stukkie hoofstukinhoud kan een van die volgende dinge wees:
 * - 'n Opskrif.
 * - 'n Lynbreuk.
 * - 'n Vers.
 * - 'n Hebreeuse ondertitel.
 */
type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

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

    /**
     * Die inhoud vir die opskrif.
     * Indien verskeie stringe in die skikking ingesluit is, moet hulle met 'n spasie gekoppel word.
     */
    content: string[];
}

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

/**
 * 'n Hebreeuse ondertitel in 'n hoofstuk.
 * Hierdie word dikwels gebruik 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 ChapterHebrewSubtitle {
    /**
     * Dui aan dat die inhoud 'n Hebreeuse ondertitel verteenwoordig.
     */
    type: 'hebrew_subtitle';

    /**
     * Die lys van inhoud wat in die subtitel voorkom.
     * Elke element in die lys kan 'n string, geformateerde teks of 'n voetnootverwysing wees.
     */
    content: (string | FormattedText | VerseFootnoteReference)[];
}

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

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

    /**
     * Die lys van inhoud vir die vers.
     * Elke element in die lys kan 'n string, geformateerde teks of 'n voetnootverwysing wees.
     */
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

/**
 * Geformateerde teks. Dit wil sê, teks wat op 'n spesifieke manier geformateer is.
 */
interface FormattedText {
    /**
     * Die teks wat geformateer is.
     */
    text: string;

    /**
     * Of die teks 'n gedig voorstel.
     * Die getal dui die vlak van inspringing aan.
     *
     * Algemeen in Psalms.
     */
    poem?: number;

    /**
     * Of die teks die Woorde van Jesus verteenwoordig.
     */
    wordsOfJesus?: boolean;
}

/**
 * Definieer 'n koppelvlak wat 'n opskrif verteenwoordig wat in 'n vers ingebed is.
 */
interface InlineHeading {
    /**
     * Die teks van die opskrif.
     */
    heading: string;
}

/**
 * Definieer 'n koppelvlak wat 'n reëlbreuk verteenwoordig wat in 'n vers ingebed is.
 */
interface InlineLineBreak {
    lineBreak: true;
}


/**
 * 'n Voetnootverwysing in 'n vers of 'n Hebreeuse ondertitel.
 */
interface VerseFootnoteReference {
    /**
     * Die ID van die nota.
     */
    noteId: number;
}

/**
 * Inligting oor 'n voetnoot.
 */
interface ChapterFootnote {
    /**
     * Die ID van die nota waarna verwys word.
     */
    noteId: number;

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

    /**
     * Die versverwysing vir die voetnoot.
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * Die oproeper wat vir die voetnoot gebruik moet word.
     * Vir voetnotas is 'n "oproeper" die karakter wat in die teks gebruik word om na 'n voetnoot te verwys.
     *
     * Byvoorbeeld, in die teks:
     * Hallo (’n) Wêreld
     *
     * ---- (a) Hierdie is 'n voetnoot.
     *
     * Die "(a)" is die oproeper.
     *
     * 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;
}

/**
 * Die klankskakels vir 'n boekhoofstuk.
 */
interface TranslationBookChapterAudioLinks {
    /**
     * Die leser vir die hoofstuk en die URL-skakel na die klanklêer.
     */
    [reader: string]: string;
}

/**
 * Die skakels na die klanktydsberekening vir 'n boekhoofstuk.
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * Die leser vir die hoofstuk en die API skakel na die oudio-tydsberekeninglêer vir daardie leser.
     */
    [reader: string]: string;
}

/**
 * Definieer die oudio-tydsberekening vir 'n boekhoofstuk, vir 'n enkele leser.
 * Kaarte na die /api/{translation}/{book}/{chapter}.{reader}.audioTimings.json eindpunt.
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * Die ID van die vertaling.
     */
    translationId: string;

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

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

    /**
     * Die ID van die leser waarvoor hierdie tye is.
     */
    reader: string;

    /**
     * Die skakel na die klanklêer waarvoor hierdie tydsberekeninge is.
     */
    audioLink: string;

    /**
     * Die skakel na die inligting vir hierdie hoofstuk.
     */
    thisChapterLink: string;

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

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

    /**
     * Die skakel na hierdie oudio-tydsberekeninglêer.
     */
    thisChapterAudioTimingsLink: string;

    /**
     * Die skakel na die tye vir die volgende hoofstuk, vir dieselfde leser.
     * Nul as dit die laaste hoofstuk in die vertaling is.
     */
    nextChapterAudioTimingsLink: string | null;

    /**
     * Die skakel na die tye vir die vorige hoofstuk, vir dieselfde leser.
     * Nul as dit die eerste hoofstuk in die vertaling is.
     */
    previousChapterAudioTimingsLink: string | null;

    /**
     * Die tye in sekondes waarop elke vers begin, in volgorde.
     * Die eerste nommer (indeks 0) is die tyd in die opname waarop die eerste vers begin.
     */
    verses: number[];
}

export interface TranslationBookChapterWords {
    /**
     * 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 inligting vir hierdie hoofstuk.
     */
    thisChapterLink: string;

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

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

    /**
     * Die skakel na hierdie woordelêer.
     */
    thisChapterWordsLink: string;

    /**
     * Die skakel na die woorde 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 woorde 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]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * Die indeks van die item in die vers se inhoudskikking waarop die aantekening van toepassing is.
     */
    contentIndex: number;

    /**
     * Die indeks van die eerste karakter van die geannoteerde woord in die inhoudsitem se teks.
     */
    start: number;

    /**
     * Die indeks na die laaste karakter van die geannoteerde woord in die inhoudsitem se teks.
     * Dit wil sê, text.slice(begin, einde) is die geannoteerde woord.
     */
    end: number;

    /**
     * Die Strong se getal(le) vir die woord.
     * Weglaat indien die vertaling slegs ander aantekeninge vir die woord verskaf het.
     */
    strongs?: string[];

    /**
     * Die woordeboekvorm (aanhaling) van die woord.
     * Weglaat indien die vertaling nie een verskaf het nie.
     */
    lemma?: string;

    /**
     * Die morfologie-ontledingskode vir die woord.
     * Weglaat indien die vertaling nie een verskaf het nie.
     */
    morph?: string;

    /**
     * Die wyser na die woord in die bronteks, in die <sourceName> : <location> formaat.
     * Weglaat indien die vertaling nie een verskaf het nie.
     */
    srcloc?: string;

    /**
     * Watter voorkoms van die bronwoord hierdie woord is. 1-gebaseer.
     * Weglaat indien die vertaling nie een verskaf het nie.
     */
    occurrence?: number;

    /**
     * Die totale aantal kere wat die bronwoord voorkom.
     * Weglaat indien die vertaling nie een verskaf het nie.
     */
    occurrences?: number;
}

/**
 * Definieer die volledige vertaling-aflaaidata.
 * Kaarteer na die /api/:translationId/complete.json eindpunt.
 */
export interface TranslationComplete {
    /**
     * Die vertalingsmetadata.
     */
    translation: Translation;

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

/**
 * 'n Boek in die volledige vertaling aflaai.
 */
export interface TranslationCompleteBook {
    /**
     * Die ID van die boek.
     */
    id: string;

    /**
     * Die naam van die boek uit die vertaling.
     */
    name: string;

    /**
     * Die algemene naam vir die boek.
     */
    commonName: string;

    /**
     * Die titel van die boek.
     */
    title: string | null;

    /**
     * Die volgorde van die boek.
     */
    order: number;

    /**
     * Die aantal hoofstukke in die boek.
     */
    numberOfChapters: number;

    /**
     * Die totale aantal verse in die boek.
     */
    totalNumberOfVerses: number;

    /**
     * Of die boek apokrief is.
     */
    isApocryphal?: boolean;

    /**
     * Die volledige lys van hoofstukke met alle inhoud.
     */
    chapters: TranslationCompleteChapter[];
}

/**
 * 'n Hoofstuk in die volledige vertaling aflaai.
 */
export interface TranslationCompleteChapter {
    /**
     * 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 verskillende oudioweergawes vir die hoofstuk.
     *
     * Anders as `thisChapterAudioTimings` op die individuele hoofstuk-eindpunt (wat skakel na "Kry die klanktydsberekening vir 'n hoofstuk" hieronder), bevat hierdie een die tydsberekening self - aangesien die punt van die volledige vertaling-aflaai is om alles in een lêer te hê.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Die skakel na die woordvlak-annotasies vir die hoofstuk.
     * Weglaat indien die hoofstuk geen woordvlak-aantekeninge het nie.
     */
    thisChapterWordsLink?: string;

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

/**
 * Die oudio-tydsberekening vir 'n boekhoofstuk, direk ingebed eerder as gekoppel.
 * Wys 'n leser-ID toe aan die lys van kere (in sekondes) wat elke vers begin, in versvolgorde.
 */
interface TranslationBookChapterAudioTimingsMap {
    [reader: string]: number[];
}