Vereinfachtes Format

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

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

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

    /**
     * Hier finden Sie den Link zur regulären (nicht vereinfachten) Version dieses Kapitels.
     */
    fullChapterApiLink: string;

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

    /**
     * Die Links zu den Audio-Zeitangaben für die verschiedenen Audioversionen des Kapitels.
     * Siehe „Audio-Timings für ein Kapitel abrufen“ in der Dokumentation zum Standardformat – die Timing-Datei ist unabhängig davon, welches Kapitelformat damit verknüpft ist, immer gleich.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Der Link zum nächsten Kapitel in vereinfachter Form.
     * 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 in vereinfachter Form.
     * 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;

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

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

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

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

    /**
     * Die Liste der Fußnoten, die keinem Vers zugeordnet werden konnten.
     * Fußnoten, die zu einem Vers gehören, sind im Vers selbst aufgeführt, daher ist diese Liste normalerweise leer.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Ein Union-Typ, der einen einzelnen Inhaltsabschnitt in einem vereinfachten Kapitel repräsentiert.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

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

    /**
     * Der Text der Überschrift.
     */
    text: string;
}

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

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

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

    /**
     * Der Text des Verses.
     * Gedichtzeilen und Zeilenumbrüche werden durch Zeilenumbruchzeichen (\n) getrennt.
     */
    text: string;

    /**
     * Die Fußnoten, die im Vers vorkommen.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Die Überschriften, die in der Mitte des Verses vorkommen.
     * Wird weggelassen, wenn der Vers keine Zwischenüberschriften enthält.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Die Textabschnitte des Verses, die die Worte Jesu darstellen.
     * Wird weggelassen, falls der Vers keinen enthält.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Die Bereiche des Verstextes, die die Zeilen des Gedichts darstellen.
     * Wird weggelassen, falls der Vers keinen enthält.
     */
    poem?: SimplePoemRange[];
}

/**
 * Ein hebräischer Untertitel in einem Kapitel.
 * Diese werden häufig als informativer Inhalt aufgeführt, der bereits in den Originalmanuskripten enthalten war.
 * Psalm 49 trägt beispielsweise den hebräischen Untertitel „Dem Chorleiter. Ein Psalm der Söhne Korachs.“
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Kennzeichnet einen hebräischen Untertitel.
     */
    type: 'hebrew_subtitle';
}

/**
 * Eine Fußnote in einem Vers.
 */
interface SimpleVerseFootnote {
    /**
     * Die ID der Notiz.
     */
    noteId: number;

    /**
     * Die Stelle im Verstext, an der der Fußnotenaufruf eingefügt werden soll.
     */
    offset: number;

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

    /**
     * Der Aufrufer, der für die Fußnote verwendet werden soll.
     * 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;
}

/**
 * Eine Überschrift, die in einen Vers eingebettet ist.
 */
interface SimpleInlineHeading {
    /**
     * Die Indexstelle im Verstext, an der die Überschrift vorkommt.
     */
    offset: number;

    /**
     * Der Text der Überschrift.
     */
    text: string;
}

/**
 * Ein Textabschnitt innerhalb eines Verses.
 */
interface SimpleTextRange {
    /**
     * Der Index des ersten Zeichens des Bereichs.
     */
    start: number;

    /**
     * Der Index nach dem letzten Zeichen des Bereichs.
     */
    end: number;
}

/**
 * Ein Textabschnitt innerhalb eines Verses, der eine Gedichtzeile darstellt.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Der Einrückungsgrad, mit dem die Gedichtzeile angezeigt werden soll.
     */
    level: number;
}

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

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

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

    /**
     * Der Link zum vereinfachten Kapitel, auf das sich diese Anmerkungen beziehen.
     */
    thisChapterLink: string;

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

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

    /**
     * Der Link zu diesen Anmerkungen.
     */
    thisChapterWordsLink: string;

    /**
     * Der Link zu den Anmerkungen für das nächste Kapitel.
     * 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 Anmerkungen des vorherigen Kapitels.
     * Null, falls dies das erste Kapitel der Übersetzung ist oder falls das vorherige Kapitel keine Wort-Ebenen-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]: SimpleChapterWord[];
    };
}

/**
 * Eine Wort-Ebene-Annotation in einem vereinfachten Kapitel.
 */
export interface SimpleChapterWord {
    /**
     * Der Index des ersten Zeichens des annotierten Wortes im Verstext.
     */
    start: number;

    /**
     * Der Index nach dem letzten Zeichen des annotierten Wortes im Verstext.
     */
    end: number;

    /**
     * Die Strong-Zahlen für das Wort.
     */
    strongs?: string[];

    /**
     * Das Lemma (die Wörterbuchform) des Wortes in der Ausgangssprache.
     */
    lemma?: string;

    /**
     * Die Morphologie des Wortes in der Ausgangssprache.
     */
    morph?: string;

    /**
     * Die Position des Wortes im Ausgangstext.
     */
    srcloc?: string;

    /**
     * Um welches Vorkommen des Wortes im Vers handelt es sich?
     */
    occurrence?: number;

    /**
     * Die Anzahl der Vorkommen des Wortes im Vers.
     */
    occurrences?: number;
}

/**
 * Definiert die vollständigen Übersetzungsdownloaddaten unter Verwendung des vereinfachten Kapitelformats.
 * Verweist auf den Endpunkt /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * Die Übersetzungsmetadaten.
     */
    translation: Translation;

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

/**
 * Ein Buch zum Herunterladen in vollständiger Übersetzung, im vereinfachten Kapitelformat.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * Die vollständige Liste der Kapitel mit allen Inhalten.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Ein Kapitel aus dem vollständigen Übersetzungsdownload, im vereinfachten Kapitelformat.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * 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 das Kapitel.
     *
     * Beachten Sie, dass die vollständigen Übersetzungsdateien die Zeitangaben selbst enthalten (siehe TranslationBookChapterAudioTimingsMap in den Standardformatdokumenten), im Gegensatz zu den einzelnen Kapitelendpunkten, die Links zu ihnen enthalten.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Der Link zu den Wort-Anmerkungen des Kapitels im vereinfachten Format. Wird weggelassen, falls das Kapitel keine Wort-Anmerkungen enthält.
     */
    thisChapterWordsLink?: string;

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