Formato semplificato

export interface SimpleTranslationBookChapter {
    /**
     * Informazioni sulla traduzione del capitolo del libro.
     */
    translation: Translation;

    /**
     * Informazioni sul capitolo del libro.
     */
    book: TranslationBook;

    /**
     * Il link al capitolo corrente.
     */
    thisChapterLink: string;

    /**
     * Il link alla versione integrale (non semplificata) di questo capitolo.
     */
    fullChapterApiLink: string;

    /**
     * I link alle diverse versioni audio del capitolo.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * I link ai tempi audio per le diverse versioni audio del capitolo.
     * Consulta la sezione "Ottieni i tempi audio per un capitolo" nella documentazione del formato standard: il file dei tempi è lo stesso indipendentemente dal formato del capitolo a cui è collegato.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Il link al capitolo successivo, in formato semplificato.
     * Nullo se questo è l'ultimo capitolo della traduzione.
     */
    nextChapterApiLink: string | null;

    /**
     * I link alle diverse versioni audio per il prossimo capitolo.
     * Nullo se questo è l'ultimo capitolo della traduzione.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Di seguito i link ai tempi audio per le diverse versioni audio del capitolo successivo.
     * Nullo se questo è l'ultimo capitolo della traduzione.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Il link al capitolo precedente, in formato semplificato.
     * Nullo se questo è il primo capitolo della traduzione.
     */
    previousChapterApiLink: string | null;

    /**
     * I link alle diverse versioni audio del capitolo precedente.
     * Nullo se questo è il primo capitolo della traduzione.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * I link ai timestamp audio per le diverse versioni audio del capitolo precedente.
     * Nullo se questo è il primo capitolo della traduzione.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Il numero di versetti contenuti nel capitolo.
     */
    numberOfVerses: number;

    /**
     * Le informazioni relative al capitolo.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * Il numero del capitolo.
     */
    number: number;

    /**
     * Il contenuto del capitolo.
     */
    content: SimpleChapterContent[];

    /**
     * Elenco delle note a piè di pagina che non è stato possibile associare a un verso.
     * Le note a piè di pagina relative a un versetto sono incluse nel versetto stesso, quindi questo elenco è solitamente vuoto.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Un tipo di unione che rappresenta un singolo elemento di contenuto in un capitolo semplificato.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Un titolo all'interno di un capitolo.
 */
interface SimpleChapterHeading {
    /**
     * Indica che il contenuto rappresenta un'intestazione.
     */
    type: 'heading';

    /**
     * Il testo dell'intestazione.
     */
    text: string;
}

/**
 * Un'interruzione di riga in un capitolo.
 */
interface ChapterLineBreak {
    /**
     * Indica che il contenuto rappresenta un'interruzione di riga.
     */
    type: 'line_break';
}

/**
 * Un versetto in un capitolo.
 */
interface SimpleChapterVerse {
    /**
     * Indica che il contenuto è un verso.
     */
    type: 'verse';

    /**
     * Il numero del versetto.
     */
    number: number;

    /**
     * Il testo del verso.
     * I versi delle poesie e le interruzioni di riga sono separati dal carattere di nuova riga (\n).
     */
    text: string;

    /**
     * Le note a piè di pagina presenti nel verso.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * I titoli che compaiono al centro del verso.
     * Omesso se il verso non contiene intestazioni in linea.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Le parti del testo del versetto che rappresentano le parole di Gesù.
     * Omesso se il verso non ne contiene.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Le porzioni di testo in versi che rappresentano le righe della poesia.
     * Omesso se il verso non ne contiene.
     */
    poem?: SimplePoemRange[];
}

/**
 * Un sottotitolo in ebraico in un capitolo.
 * Questi elementi sono spesso inclusi come contenuti informativi presenti nei manoscritti originali.
 * Ad esempio, il Salmo 49 ha il sottotitolo ebraico "Al maestro del coro. Salmo dei figli di Core".
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Indica che il contenuto rappresenta un sottotitolo in ebraico.
     */
    type: 'hebrew_subtitle';
}

/**
 * Una nota a piè di pagina in un verso.
 */
interface SimpleVerseFootnote {
    /**
     * L'ID della nota.
     */
    noteId: number;

    /**
     * L'indice nel testo del verso in cui deve essere inserito il richiamo alla nota a piè di pagina.
     */
    offset: number;

    /**
     * Il testo della nota a piè di pagina.
     */
    text: string;

    /**
     * Il chiamante da utilizzare per la nota a piè di pagina.
     * Se "+", il chiamante dovrebbe essere generato automaticamente.
     * Se nullo, il chiamante deve essere vuoto.
     * Se si tratta di una stringa, il chiamante dovrebbe essere quella stringa.
     */
    caller: '+' | string | null;
}

/**
 * Un titolo inserito all'interno di un verso.
 */
interface SimpleInlineHeading {
    /**
     * L'indice nel testo del verso in cui compare il titolo.
     */
    offset: number;

    /**
     * Il testo dell'intestazione.
     */
    text: string;
}

/**
 * Una porzione di testo all'interno di un verso.
 */
interface SimpleTextRange {
    /**
     * L'indice del primo carattere dell'intervallo.
     */
    start: number;

    /**
     * L'indice che segue l'ultimo carattere dell'intervallo.
     */
    end: number;
}

/**
 * Una porzione di testo all'interno di un verso che rappresenta una riga di poesia.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Il livello di rientro con cui deve essere visualizzato il verso della poesia.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * L'ID della traduzione.
     */
    translationId: string;

    /**
     * L'ID del libro.
     */
    bookId: string;

    /**
     * Il numero del capitolo.
     */
    chapterNumber: number;

    /**
     * Il link al capitolo semplificato a cui si riferiscono queste annotazioni.
     */
    thisChapterLink: string;

    /**
     * Il link al capitolo successivo in versione semplificata.
     * Nullo se questo è l'ultimo capitolo della traduzione.
     */
    nextChapterLink: string | null;

    /**
     * Il link al capitolo precedente, in versione semplificata.
     * Nullo se questo è il primo capitolo della traduzione.
     */
    previousChapterLink: string | null;

    /**
     * Il link a queste annotazioni.
     */
    thisChapterWordsLink: string;

    /**
     * Ecco il link alle annotazioni per il capitolo successivo.
     * Valore nullo se questo è l'ultimo capitolo della traduzione, oppure se il capitolo successivo non presenta annotazioni a livello di parola.
     */
    nextChapterWordsLink: string | null;

    /**
     * Il link alle annotazioni del capitolo precedente.
     * Valore nullo se si tratta del primo capitolo della traduzione o se il capitolo precedente non presenta annotazioni a livello di parola.
     */
    previousChapterWordsLink: string | null;

    /**
     * Le parole annotate per ogni versetto del capitolo, ordinate per numero di versetto.
     * Ogni elenco segue l'ordine in cui le parole compaiono nel versetto.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Annotazioni a livello di parola in un capitolo semplificato.
 */
export interface SimpleChapterWord {
    /**
     * L'indice del primo carattere della parola annotata nel testo del verso.
     */
    start: number;

    /**
     * L'indice che segue l'ultimo carattere della parola annotata nel testo del verso.
     */
    end: number;

    /**
     * I numeri di Strong per la parola.
     */
    strongs?: string[];

    /**
     * Il lemma (forma lessicale) della parola nella lingua di origine.
     */
    lemma?: string;

    /**
     * La morfologia della parola nella lingua di origine.
     */
    morph?: string;

    /**
     * La posizione della parola nel testo di origine.
     */
    srcloc?: string;

    /**
     * Di quale occorrenza della parola si tratta nel verso.
     */
    occurrence?: number;

    /**
     * Il numero di volte in cui la parola ricorre nel verso.
     */
    occurrences?: number;
}

/**
 * Definisce i dati completi per il download della traduzione, utilizzando il formato capitolo semplificato.
 * Corrisponde all'endpoint /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * I metadati di traduzione.
     */
    translation: Translation;

    /**
     * L'elenco completo dei libri con tutti i loro capitoli.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Un libro nella sua traduzione integrale, scaricabile utilizzando il formato a capitoli semplificato.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * L'elenco completo dei capitoli con tutti i contenuti.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Un capitolo della traduzione completa scaricabile, utilizzando il formato di capitolo semplificato.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * Il numero di versetti contenuti nel capitolo.
     */
    numberOfVerses: number;

    /**
     * I link alle diverse versioni audio del capitolo.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Le tempistiche audio (orari di inizio di ogni strofa, in secondi) per il capitolo.
     *
     * Si noti che i file di traduzione completi contengono le tempistiche stesse (vedere TranslationBookChapterAudioTimingsMap nella documentazione del formato standard), a differenza dei singoli punti finali dei capitoli, che contengono collegamenti a tali tempistiche.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Il collegamento alle annotazioni a livello di parola per il capitolo, utilizzando il formato semplificato. Omesso se il capitolo non presenta annotazioni a livello di parola.
     */
    thisChapterWordsLink?: string;

    /**
     * Informazioni semplificate per il capitolo.
     */
    chapter: SimpleChapterData;
}