Standardformat

export interface TranslationBookChapter {
    /**
     * Die Übersetzungsinformationen für das Buchkapitel.
     */
    translation: Translation;

    /**
     * Die Buchinformationen für das Buchkapitel.
     */
    book: TranslationBook;

    /**
     * Der Link zum aktuellen Kapitel.
     */
    thisChapterLink: string;

    /**
     * Die Links zu verschiedenen Audioversionen des Kapitels.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Die Links zu den Audio-Zeitangaben für die verschiedenen Audioversionen des Kapitels.
     * Jeder Link verweist auf die Audio-Timing-Datei für den jeweiligen Reader – siehe „Audio-Timings für ein Kapitel abrufen“ weiter unten.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Der Link zum nächsten Kapitel.
     * Null, falls dies das letzte Kapitel der Übersetzung ist.
     */
    nextChapterApiLink: string | null;

    /**
     * Die Links zu verschiedenen Audioversionen für das nächste Kapitel.
     * Null, falls dies das letzte Kapitel der Übersetzung ist.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Die Links zu den Audio-Zeitangaben für verschiedene Audioversionen für das nächste Kapitel.
     * Null, falls dies das letzte Kapitel der Übersetzung ist.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Der Link zum vorherigen Kapitel.
     * Null, falls dies das erste Kapitel der Übersetzung ist.
     */
    previousChapterApiLink: string | null;

    /**
     * Die Links zu verschiedenen Audioversionen des vorherigen Kapitels.
     * Null, falls dies das erste Kapitel der Übersetzung ist.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Die Links zu den Audio-Zeitangaben für verschiedene Audioversionen des vorherigen Kapitels.
     * Null, falls dies das erste Kapitel der Übersetzung ist.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Der Link zu den Wort-Ebenen-Annotationen für das Kapitel.
     * Wird ausgelassen, wenn das Kapitel keine Wort-Ebenen-Anmerkungen enthält.
     */
    thisChapterWordsLink?: string;

    /**
     * Der Link zu den Wort-Ebenen-Annotationen für das nächste Kapitel.
     * Wird ausgelassen, wenn dies das letzte Kapitel der Übersetzung ist oder wenn das nächste Kapitel keine Wort-Ebene-Anmerkungen enthält.
     */
    nextChapterWordsLink?: string;

    /**
     * Der Link zu den Wort-Ebenen-Annotationen des vorherigen Kapitels.
     * Wird weggelassen, wenn es sich um das erste Kapitel der Übersetzung handelt oder wenn das vorherige Kapitel keine Wort-Ebene-Anmerkungen enthält.
     */
    previousChapterWordsLink?: string;

    /**
     * Die Anzahl der Verse, die das Kapitel enthält.
     */
    numberOfVerses: number;

    /**
     * Hier finden Sie den Link zur vereinfachten Version dieses Kapitels.
     * Wird ausgelassen, falls keine vereinfachten Kapitel verfügbar sind.
     */
    simpleChapterApiLink?: string;

    /**
     * Die Informationen für das Kapitel.
     */
    chapter: ChapterData;
}

interface ChapterData {
    /**
     * Die Kapitelnummer.
     */
    number: number;

    /**
     * Der Inhalt des Kapitels.
     */
    content: ChapterContent[];

    /**
     * Das Fußnotenverzeichnis zum Kapitel.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Ein Union-Typ, der einen einzelnen Abschnitt des Kapitelinhalts repräsentiert.
 * Ein Kapitelinhalt kann beispielsweise Folgendes umfassen:
 * - Eine Überschrift.
 * - Ein Zeilenumbruch.
 * - Ein Vers.
 * - Ein hebräischer Untertitel.
 */
type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

/**
 * Eine Überschrift in einem Kapitel.
 */
interface ChapterHeading {
    /**
     * Kennzeichnet einen Inhalt, der eine Überschrift darstellt.
     */
    type: 'heading';

    /**
     * Der Inhalt für die Überschrift.
     * Wenn mehrere Zeichenketten im Array enthalten sind, sollten diese mit einem Leerzeichen verkettet werden.
     */
    content: string[];
}

/**
 * Ein Zeilenumbruch in einem Kapitel.
 */
interface ChapterLineBreak {
    /**
     * Zeigt an, dass der Inhalt einen Zeilenumbruch darstellt.
     */
    type: 'line_break';
}

/**
 * Ein hebräischer Untertitel in einem Kapitel.
 * Diese werden häufig als informativer Inhalt verwendet, der in den Originalmanuskripten enthalten war.
 * Psalm 49 trägt beispielsweise den hebräischen Untertitel „Dem Chorleiter. Ein Psalm der Söhne Korachs.“
 */
interface ChapterHebrewSubtitle {
    /**
     * Kennzeichnet einen hebräischen Untertitel.
     */
    type: 'hebrew_subtitle';

    /**
     * Die im Untertitel enthaltene Inhaltsliste.
     * Jedes Element in der Liste kann eine Zeichenkette, formatierter Text oder ein Fußnotenverweis sein.
     */
    content: (string | FormattedText | VerseFootnoteReference)[];
}

/**
 * Ein Vers in einem Kapitel.
 */
interface ChapterVerse {
    /**
     * Zeigt an, dass es sich bei dem Inhalt um einen Vers handelt.
     */
    type: 'verse';

    /**
     * Die Versnummer.
     */
    number: number;

    /**
     * Die Inhaltsangabe für den Vers.
     * Jedes Element in der Liste kann eine Zeichenkette, formatierter Text oder ein Fußnotenverweis sein.
     */
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

/**
 * Formatierter Text. Das heißt, Text, der auf eine bestimmte Weise formatiert ist.
 */
interface FormattedText {
    /**
     * Der formatierte Text.
     */
    text: string;

    /**
     * Ob der Text ein Gedicht darstellt.
     * Die Zahl gibt die Einrückungsebene an.
     *
     * Häufig in den Psalmen.
     */
    poem?: number;

    /**
     * Ob der Text die Worte Jesu wiedergibt.
     */
    wordsOfJesus?: boolean;
}

/**
 * Definiert eine Schnittstelle, die eine in einen Vers eingebettete Überschrift darstellt.
 */
interface InlineHeading {
    /**
     * Der Text der Überschrift.
     */
    heading: string;
}

/**
 * Definiert eine Schnittstelle, die einen in einen Vers eingebetteten Zeilenumbruch darstellt.
 */
interface InlineLineBreak {
    lineBreak: true;
}


/**
 * Eine Fußnotenreferenz in einem Vers oder einem hebräischen Untertitel.
 */
interface VerseFootnoteReference {
    /**
     * Die ID der Notiz.
     */
    noteId: number;
}

/**
 * Informationen zu einer Fußnote.
 */
interface ChapterFootnote {
    /**
     * Die ID der Notiz, auf die Bezug genommen wird.
     */
    noteId: number;

    /**
     * Der Text der Fußnote.
     */
    text: string;

    /**
     * Die Versreferenz für die Fußnote.
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * Der Aufrufer, der für die Fußnote verwendet werden soll.
     * Bei Fußnoten ist der sogenannte „Aufrufer“ das Zeichen, das im Text verwendet wird, um auf die Fußnote zu verweisen.
     *
     * Zum Beispiel im Text:
     * Hallo Welt
     *
     * ---- (a) Dies ist eine Fußnote.
     *
     * Das "(a)" ist der Anrufer.
     *
     * Bei einem "+" sollte der Aufrufer automatisch generiert werden.
     * Wenn null, dann sollte der Aufrufer leer sein.
     * Wenn es sich um eine Zeichenkette handelt, dann sollte der Aufrufer diese Zeichenkette sein.
     */
    caller: '+' | string | null;
}

/**
 * Die Audio-Links zu einem Buchkapitel.
 */
interface TranslationBookChapterAudioLinks {
    /**
     * Der Reader für das Kapitel und der URL-Link zur Audiodatei.
     */
    [reader: string]: string;
}

/**
 * Die Audio-Zeitangaben für ein Buchkapitel.
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * Der Reader für das Kapitel und der API-Link zur Audio-Timing-Datei für diesen Reader.
     */
    [reader: string]: string;
}

/**
 * Definiert die Audio-Zeiten für ein Buchkapitel für einen einzelnen Leser.
 * Ordnet dem Endpunkt /api/{translation}/{book}/{chapter}.{reader}.audioTimings.json zu.
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * Die ID der Übersetzung.
     */
    translationId: string;

    /**
     * Die ID des Buches.
     */
    bookId: string;

    /**
     * Die Kapitelnummer.
     */
    chapterNumber: number;

    /**
     * Die ID des Lesers, für den diese Zeitangaben gelten.
     */
    reader: string;

    /**
     * Der Link zur Audiodatei, auf die sich diese Zeitangaben beziehen.
     */
    audioLink: string;

    /**
     * Der Link zu den Informationen für dieses Kapitel.
     */
    thisChapterLink: string;

    /**
     * Der Link zu den Informationen für das nächste Kapitel.
     * Null, falls dies das letzte Kapitel der Übersetzung ist.
     */
    nextChapterLink: string | null;

    /**
     * Der Link zu den Informationen des vorherigen Kapitels.
     * Null, falls dies das erste Kapitel der Übersetzung ist.
     */
    previousChapterLink: string | null;

    /**
     * Der Link zu dieser Audio-Timing-Datei.
     */
    thisChapterAudioTimingsLink: string;

    /**
     * Hier der Link zu den Zeitangaben für das nächste Kapitel, für denselben Leser.
     * Null, falls dies das letzte Kapitel der Übersetzung ist.
     */
    nextChapterAudioTimingsLink: string | null;

    /**
     * Hier der Link zu den Zeitangaben des vorherigen Kapitels für denselben Leser.
     * Null, falls dies das erste Kapitel der Übersetzung ist.
     */
    previousChapterAudioTimingsLink: string | null;

    /**
     * Die Zeitpunkte in Sekunden, zu denen die einzelnen Strophen beginnen, in der Reihenfolge ihres Beginns.
     * Die erste Zahl (Index 0) ist die Zeit in der Aufnahme, zu der die erste Strophe beginnt.
     */
    verses: number[];
}

export interface TranslationBookChapterWords {
    /**
     * Die ID der Übersetzung.
     */
    translationId: string;

    /**
     * Die ID des Buches.
     */
    bookId: string;

    /**
     * Die Kapitelnummer.
     */
    chapterNumber: number;

    /**
     * Der Link zu den Informationen für dieses Kapitel.
     */
    thisChapterLink: string;

    /**
     * Der Link zu den Informationen für das nächste Kapitel.
     * Null, falls dies das letzte Kapitel der Übersetzung ist.
     */
    nextChapterLink: string | null;

    /**
     * Der Link zu den Informationen des vorherigen Kapitels.
     * Null, falls dies das erste Kapitel der Übersetzung ist.
     */
    previousChapterLink: string | null;

    /**
     * Der Link zu dieser Word-Datei.
     */
    thisChapterWordsLink: string;

    /**
     * Der Link zum Text des nächsten Kapitels.
     * Null, falls dies das letzte Kapitel der Übersetzung ist oder falls das nächste Kapitel keine Wort-Ebenen-Anmerkungen enthält.
     */
    nextChapterWordsLink: string | null;

    /**
     * Der Link zu den Wörtern des vorherigen Kapitels.
     * Null, falls dies das erste Kapitel der Übersetzung ist oder falls das vorherige Kapitel keine Wort-Ebene-Anmerkungen enthält.
     */
    previousChapterWordsLink: string | null;

    /**
     * Die kommentierten Wörter für jeden Vers im Kapitel, geordnet nach Versnummer.
     * Die Listen sind in der Reihenfolge angeordnet, in der die Wörter im Vers vorkommen.
     */
    verses: {
        [verseNumber: string]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * Der Index des Elements im Inhaltsarray des Verses, auf das sich die Annotation bezieht.
     */
    contentIndex: number;

    /**
     * Der Index des ersten Zeichens des annotierten Wortes im Text des Inhaltselements.
     */
    start: number;

    /**
     * Der Index nach dem letzten Zeichen des annotierten Wortes im Text des Inhaltselements.
     * Das heißt, text.slice(start, end) ist das annotierte Wort.
     */
    end: number;

    /**
     * Die Strong-Nummer(n) für das Wort.
     * Wird weggelassen, wenn die Übersetzung nur andere Anmerkungen zu dem Wort enthielt.
     */
    strongs?: string[];

    /**
     * Die Wörterbuchform (Zitatform) des Wortes.
     * Wird weggelassen, falls die Übersetzung keine Angabe enthielt.
     */
    lemma?: string;

    /**
     * Der morphologische Analysecode für das Wort.
     * Wird weggelassen, falls die Übersetzung keine Angabe enthielt.
     */
    morph?: string;

    /**
     * Der Zeiger auf das Wort im Quelltext im Format <sourceName> : <location> .
     * Wird weggelassen, falls die Übersetzung keine Angabe enthielt.
     */
    srcloc?: string;

    /**
     * Auf welcher Stelle des Quellwortes dieses Wort basiert. 1-basiert.
     * Wird weggelassen, falls die Übersetzung keine Angabe enthielt.
     */
    occurrence?: number;

    /**
     * Die Gesamtzahl der Vorkommen des Quellworts.
     * Wird weggelassen, falls die Übersetzung keine Angabe enthielt.
     */
    occurrences?: number;
}

/**
 * Definiert die vollständigen Übersetzungsdownloaddaten.
 * Verweist auf den Endpunkt /api/:translationId/complete.json.
 */
export interface TranslationComplete {
    /**
     * Die Übersetzungsmetadaten.
     */
    translation: Translation;

    /**
     * Die vollständige Liste der Bücher mit allen ihren Kapiteln.
     */
    books: TranslationCompleteBook[];
}

/**
 * Ein Buch in vollständiger Übersetzung zum Download.
 */
export interface TranslationCompleteBook {
    /**
     * Die ID des Buches.
     */
    id: string;

    /**
     * Der Name des Buches aus der Übersetzung.
     */
    name: string;

    /**
     * Der gebräuchliche Name für das Buch.
     */
    commonName: string;

    /**
     * Der Titel des Buches.
     */
    title: string | null;

    /**
     * Die Reihenfolge des Buches.
     */
    order: number;

    /**
     * Die Anzahl der Kapitel im Buch.
     */
    numberOfChapters: number;

    /**
     * Die Gesamtzahl der Verse im Buch.
     */
    totalNumberOfVerses: number;

    /**
     * Ob das Buch apokryph ist.
     */
    isApocryphal?: boolean;

    /**
     * Die vollständige Liste der Kapitel mit allen Inhalten.
     */
    chapters: TranslationCompleteChapter[];
}

/**
 * Ein Kapitel aus dem vollständigen Übersetzungs-Download.
 */
export interface TranslationCompleteChapter {
    /**
     * Die Anzahl der Verse, die das Kapitel enthält.
     */
    numberOfVerses: number;

    /**
     * Die Links zu verschiedenen Audioversionen des Kapitels.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Die Audio-Zeitangaben (Startzeiten pro Vers, in Sekunden) für die verschiedenen Audioversionen des Kapitels.
     *
     * Im Gegensatz zu `thisChapterAudioTimings` am Endpunkt des einzelnen Kapitels (der weiter unten auf „Audio-Timings für ein Kapitel abrufen“ verlinkt) enthält dieser Link die Timings selbst – denn der Sinn des Downloads der kompletten Übersetzung besteht darin, alles in einer Datei zu haben.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Der Link zu den Wort-Ebenen-Annotationen für das Kapitel.
     * Wird ausgelassen, wenn das Kapitel keine Wort-Ebenen-Anmerkungen enthält.
     */
    thisChapterWordsLink?: string;

    /**
     * Die Informationen für das Kapitel.
     */
    chapter: ChapterData;
}

/**
 * Die Audio-Zeitangaben für ein Buchkapitel, direkt eingebettet und nicht verlinkt.
 * Ordnet eine Leser-ID der Liste der Startzeiten (in Sekunden) der einzelnen Verse in der Reihenfolge ihrer Verse zu.
 */
interface TranslationBookChapterAudioTimingsMap {
    [reader: string]: number[];
}