Format simplifié

export interface SimpleTranslationBookChapter {
    /**
     * Informations relatives à la traduction du chapitre du livre.
     */
    translation: Translation;

    /**
     * Informations relatives au chapitre du livre.
     */
    book: TranslationBook;

    /**
     * Le lien vers le chapitre actuel.
     */
    thisChapterLink: string;

    /**
     * Voici le lien vers la version normale (non simplifiée) de ce chapitre.
     */
    fullChapterApiLink: string;

    /**
     * Les liens vers les différentes versions audio du chapitre.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Les liens vers les minutages audio des différentes versions audio du chapitre.
     * Consultez la section « Obtenir les minutages audio d'un chapitre » dans la documentation relative au format standard ; le fichier de minutage est identique quel que soit le format de chapitre auquel il est lié.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Le lien vers le chapitre suivant, en format simplifié.
     * Nul si c'est le dernier chapitre de la traduction.
     */
    nextChapterApiLink: string | null;

    /**
     * Voici les liens vers les différentes versions audio du chapitre suivant.
     * Nul si c'est le dernier chapitre de la traduction.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Voici les liens vers les minutages audio des différentes versions audio du chapitre suivant.
     * Nul si c'est le dernier chapitre de la traduction.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Le lien vers le chapitre précédent, en format simplifié.
     * Nul si c'est le premier chapitre de la traduction.
     */
    previousChapterApiLink: string | null;

    /**
     * Les liens vers les différentes versions audio du chapitre précédent.
     * Nul si c'est le premier chapitre de la traduction.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Voici les liens vers les minutages audio des différentes versions audio du chapitre précédent.
     * Nul si c'est le premier chapitre de la traduction.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Le nombre de versets que contient le chapitre.
     */
    numberOfVerses: number;

    /**
     * Informations relatives à ce chapitre.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * Le numéro du chapitre.
     */
    number: number;

    /**
     * Le contenu du chapitre.
     */
    content: SimpleChapterContent[];

    /**
     * Liste des notes de bas de page qui n'ont pu être associées à aucun verset.
     * Les notes de bas de page relatives à un verset sont incluses dans le verset lui-même, cette liste est donc généralement vide.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Un type union qui représente un seul élément de contenu dans un chapitre simplifié.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Un titre de chapitre.
 */
interface SimpleChapterHeading {
    /**
     * Indique que le contenu représente un titre.
     */
    type: 'heading';

    /**
     * Le texte de l'en-tête.
     */
    text: string;
}

/**
 * Un saut de ligne dans un chapitre.
 */
interface ChapterLineBreak {
    /**
     * Indique que le contenu représente un saut de ligne.
     */
    type: 'line_break';
}

/**
 * Un verset dans un chapitre.
 */
interface SimpleChapterVerse {
    /**
     * Indique que le contenu est un verset.
     */
    type: 'verse';

    /**
     * Le numéro du verset.
     */
    number: number;

    /**
     * Le texte du verset.
     * Les vers de poésie et les sauts de ligne sont séparés par des caractères de nouvelle ligne (\n).
     */
    text: string;

    /**
     * Les notes de bas de page qui apparaissent dans le verset.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Les titres qui apparaissent au milieu du verset.
     * Omis si le verset ne contient aucun titre en ligne.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Les passages du texte des versets qui représentent les paroles de Jésus.
     * Omis si le verset n'en contient aucun.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Les sections du texte en vers qui représentent les lignes de poésie.
     * Omis si le verset n'en contient aucun.
     */
    poem?: SimplePoemRange[];
}

/**
 * Un sous-titre hébreu dans un chapitre.
 * Ces éléments sont souvent inclus à titre de contenu informatif figurant dans les manuscrits originaux.
 * Par exemple, le Psaume 49 porte le sous-titre hébreu « Au chef de chœur. Psaume des fils de Coré. »
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Indique que le contenu représente un sous-titre en hébreu.
     */
    type: 'hebrew_subtitle';
}

/**
 * Une note de bas de page dans un verset.
 */
interface SimpleVerseFootnote {
    /**
     * L'identifiant du billet.
     */
    noteId: number;

    /**
     * L'index dans le texte du verset où doit être insérée la note de bas de page.
     */
    offset: number;

    /**
     * Le texte de la note de bas de page.
     */
    text: string;

    /**
     * L'appelant à utiliser pour la note de bas de page.
     * Si "+", alors l'appelant doit être généré automatiquement.
     * Si la valeur est nulle, l'appelant doit être vide.
     * Si c'est une chaîne de caractères, alors l'appelant doit être cette chaîne.
     */
    caller: '+' | string | null;
}

/**
 * Un titre intégré à un verset.
 */
interface SimpleInlineHeading {
    /**
     * L'indice dans le texte du verset où apparaît le titre.
     */
    offset: number;

    /**
     * Le texte de l'en-tête.
     */
    text: string;
}

/**
 * Un ensemble de texte à l'intérieur d'un verset.
 */
interface SimpleTextRange {
    /**
     * L'indice du premier caractère de la plage.
     */
    start: number;

    /**
     * L'indice suivant le dernier caractère de la plage.
     */
    end: number;
}

/**
 * Un ensemble de texte à l'intérieur d'un vers qui représente un vers de poésie.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Le niveau d'indentation avec lequel le vers de poésie doit être affiché.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * L'identifiant de la traduction.
     */
    translationId: string;

    /**
     * L'identifiant du livre.
     */
    bookId: string;

    /**
     * Le numéro du chapitre.
     */
    chapterNumber: number;

    /**
     * Le lien vers le chapitre simplifié auquel ces annotations se rapportent.
     */
    thisChapterLink: string;

    /**
     * Le lien vers le chapitre simplifié suivant.
     * Nul si c'est le dernier chapitre de la traduction.
     */
    nextChapterLink: string | null;

    /**
     * Le lien vers le chapitre simplifié précédent.
     * Nul si c'est le premier chapitre de la traduction.
     */
    previousChapterLink: string | null;

    /**
     * Le lien vers ces annotations.
     */
    thisChapterWordsLink: string;

    /**
     * Le lien vers les annotations du chapitre suivant.
     * Nul si c'est le dernier chapitre de la traduction, ou si le chapitre suivant ne comporte aucune annotation au niveau des mots.
     */
    nextChapterWordsLink: string | null;

    /**
     * Le lien vers les annotations du chapitre précédent.
     * Nul si c'est le premier chapitre de la traduction, ou si le chapitre précédent ne comporte aucune annotation au niveau des mots.
     */
    previousChapterWordsLink: string | null;

    /**
     * Les mots annotés pour chaque verset du chapitre, classés par numéro de verset.
     * Chaque liste suit l'ordre d'apparition des mots dans le verset.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Une annotation au niveau du mot dans un chapitre simplifié.
 */
export interface SimpleChapterWord {
    /**
     * L'indice du premier caractère du mot annoté dans le texte du verset.
     */
    start: number;

    /**
     * L'indice suivant le dernier caractère du mot annoté dans le texte du verset.
     */
    end: number;

    /**
     * Les chiffres Strong pour ce mot.
     */
    strongs?: string[];

    /**
     * Le lemme (forme de dictionnaire) du mot dans la langue source.
     */
    lemma?: string;

    /**
     * La morphologie du mot dans la langue source.
     */
    morph?: string;

    /**
     * L'emplacement du mot dans le texte source.
     */
    srcloc?: string;

    /**
     * De quelle occurrence du mot s'agit-il dans le verset ?
     */
    occurrence?: number;

    /**
     * Le nombre de fois où le mot apparaît dans le verset.
     */
    occurrences?: number;
}

/**
 * Définit les données complètes de téléchargement de la traduction, en utilisant le format de chapitre simplifié.
 * Correspond au point de terminaison /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * Les métadonnées de traduction.
     */
    translation: Translation;

    /**
     * La liste complète des livres avec tous leurs chapitres.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Un livre en téléchargement avec traduction intégrale, utilisant le format de chapitres simplifiés.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * La liste complète des chapitres avec leur contenu.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Un chapitre du téléchargement de la traduction complète, utilisant le format de chapitre simplifié.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * Le nombre de versets que contient le chapitre.
     */
    numberOfVerses: number;

    /**
     * Les liens vers les différentes versions audio du chapitre.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Les minutages audio (heures de début par verset, en secondes) pour le chapitre.
     *
     * Notez que les fichiers de traduction complets contiennent les minutages eux-mêmes (voir TranslationBookChapterAudioTimingsMap dans la documentation du format standard), contrairement aux points de fin de chapitre individuels, qui contiennent des liens vers ceux-ci.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Lien vers les annotations lexicales du chapitre, au format simplifié. Omis si le chapitre ne comporte aucune annotation lexicale.
     */
    thisChapterWordsLink?: string;

    /**
     * Informations simplifiées pour ce chapitre.
     */
    chapter: SimpleChapterData;
}