Formato simplificado

export interface SimpleTranslationBookChapter {
    /**
     * Informações sobre a tradução do capítulo do livro.
     */
    translation: Translation;

    /**
     * Informações sobre o capítulo do livro.
     */
    book: TranslationBook;

    /**
     * O link para o capítulo atual.
     */
    thisChapterLink: string;

    /**
     * O link para a versão completa (não simplificada) deste capítulo.
     */
    fullChapterApiLink: string;

    /**
     * Os links para as diferentes versões em áudio do capítulo.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Os links para os tempos de áudio das diferentes versões em áudio do capítulo.
     * Consulte "Obter os tempos de áudio de um capítulo" na documentação do formato padrão - o arquivo de tempos é o mesmo, independentemente do formato do capítulo ao qual ele está vinculado.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * O link para o próximo capítulo, em formato simplificado.
     * Nulo se este for o último capítulo da tradução.
     */
    nextChapterApiLink: string | null;

    /**
     * Os links para as diferentes versões em áudio do próximo capítulo.
     * Nulo se este for o último capítulo da tradução.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Os links para os tempos de áudio das diferentes versões do próximo capítulo.
     * Nulo se este for o último capítulo da tradução.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * O link para o capítulo anterior, em formato simplificado.
     * Nulo se este for o primeiro capítulo da tradução.
     */
    previousChapterApiLink: string | null;

    /**
     * Os links para as diferentes versões em áudio do capítulo anterior.
     * Nulo se este for o primeiro capítulo da tradução.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Os links para os tempos de áudio das diferentes versões do capítulo anterior.
     * Nulo se este for o primeiro capítulo da tradução.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * O número de versículos que o capítulo contém.
     */
    numberOfVerses: number;

    /**
     * As informações para o capítulo.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * O número do capítulo.
     */
    number: number;

    /**
     * O conteúdo do capítulo.
     */
    content: SimpleChapterContent[];

    /**
     * Lista de notas de rodapé que não puderam ser associadas a nenhum verso.
     * As notas de rodapé que pertencem a um versículo são incluídas no próprio versículo, portanto, essa lista geralmente está vazia.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Um tipo de união que representa um único elemento de conteúdo em um capítulo simplificado.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Um título em um capítulo.
 */
interface SimpleChapterHeading {
    /**
     * Indica que o conteúdo representa um título.
     */
    type: 'heading';

    /**
     * O texto do título.
     */
    text: string;
}

/**
 * Uma quebra de linha em um capítulo.
 */
interface ChapterLineBreak {
    /**
     * Indica que o conteúdo representa uma quebra de linha.
     */
    type: 'line_break';
}

/**
 * Um versículo em um capítulo.
 */
interface SimpleChapterVerse {
    /**
     * Indica que o conteúdo é um verso.
     */
    type: 'verse';

    /**
     * O número do versículo.
     */
    number: number;

    /**
     * O texto do versículo.
     * Os versos e as quebras de linha são separados por caracteres de nova linha (\n).
     */
    text: string;

    /**
     * As notas de rodapé que aparecem no verso.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Os títulos que aparecem no meio do versículo.
     * Omitido se o versículo não contiver títulos embutidos.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Os trechos do texto bíblico que representam as Palavras de Jesus.
     * Omitido se o verso não o contiver.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Os trechos do texto em verso que representam as linhas da poesia.
     * Omitido se o verso não o contiver.
     */
    poem?: SimplePoemRange[];
}

/**
 * Legenda em hebraico em um capítulo.
 * Esses elementos são frequentemente incluídos como conteúdo informativo que aparecia nos manuscritos originais.
 * Por exemplo, o Salmo 49 tem o subtítulo em hebraico "Ao mestre de canto. Salmo dos filhos de Corá".
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Indica que o conteúdo representa uma legenda em hebraico.
     */
    type: 'hebrew_subtitle';
}

/**
 * Uma nota de rodapé em um verso.
 */
interface SimpleVerseFootnote {
    /**
     * O ID da nota.
     */
    noteId: number;

    /**
     * O índice no texto do versículo onde a chamada da nota de rodapé deve ser inserida.
     */
    offset: number;

    /**
     * O texto da nota de rodapé.
     */
    text: string;

    /**
     * O identificador que deve ser usado para a nota de rodapé.
     * Se "+", então o chamador deve ser gerado automaticamente.
     * Se for nulo, o chamador deverá estar vazio.
     * Se for uma string, então o chamador deve ser essa string.
     */
    caller: '+' | string | null;
}

/**
 * Um título que está inserido em um versículo.
 */
interface SimpleInlineHeading {
    /**
     * O índice no texto do versículo indica onde o título aparece.
     */
    offset: number;

    /**
     * O texto do título.
     */
    text: string;
}

/**
 * Um trecho de texto dentro de um verso.
 */
interface SimpleTextRange {
    /**
     * O índice do primeiro caractere do intervalo.
     */
    start: number;

    /**
     * O índice após o último caractere do intervalo.
     */
    end: number;
}

/**
 * Um trecho de texto dentro de um verso que representa uma linha poética.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * O nível de recuo com que o verso do poema deve ser exibido.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * O ID da tradução.
     */
    translationId: string;

    /**
     * A identificação do livro.
     */
    bookId: string;

    /**
     * O número do capítulo.
     */
    chapterNumber: number;

    /**
     * O link para o capítulo simplificado ao qual estas anotações se referem.
     */
    thisChapterLink: string;

    /**
     * O link para o próximo capítulo simplificado.
     * Nulo se este for o último capítulo da tradução.
     */
    nextChapterLink: string | null;

    /**
     * O link para o capítulo simplificado anterior.
     * Nulo se este for o primeiro capítulo da tradução.
     */
    previousChapterLink: string | null;

    /**
     * O link para essas anotações.
     */
    thisChapterWordsLink: string;

    /**
     * O link para as anotações do próximo capítulo.
     * Nulo se este for o último capítulo da tradução ou se o próximo capítulo não tiver anotações em nível de palavra.
     */
    nextChapterWordsLink: string | null;

    /**
     * O link para as anotações do capítulo anterior.
     * Nulo se este for o primeiro capítulo da tradução ou se o capítulo anterior não tiver anotações em nível de palavra.
     */
    previousChapterWordsLink: string | null;

    /**
     * As palavras anotadas para cada versículo do capítulo, identificadas pelo número do versículo.
     * Cada lista está na ordem em que as palavras aparecem no versículo.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Anotações em nível de palavra em um capítulo simplificado.
 */
export interface SimpleChapterWord {
    /**
     * O índice do primeiro caractere da palavra anotada no texto do verso.
     */
    start: number;

    /**
     * O índice que se encontra após o último caractere da palavra anotada no texto do verso.
     */
    end: number;

    /**
     * Os números de Strong para a palavra.
     */
    strongs?: string[];

    /**
     * O lema (forma de dicionário) da palavra na língua de origem.
     */
    lemma?: string;

    /**
     * A morfologia da palavra na língua de origem.
     */
    morph?: string;

    /**
     * A localização da palavra no texto original.
     */
    srcloc?: string;

    /**
     * Em qual ocorrência da palavra no versículo isso acontece?
     */
    occurrence?: number;

    /**
     * O número de vezes que a palavra aparece no versículo.
     */
    occurrences?: number;
}

/**
 * Define os dados completos de download da tradução, usando o formato de capítulo simplificado.
 * Mapeia para o endpoint /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * Os metadados da tradução.
     */
    translation: Translation;

    /**
     * A lista completa dos livros com todos os seus capítulos.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Um livro em tradução completa para download, utilizando o formato de capítulos simplificado.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * Lista completa dos capítulos com todo o conteúdo.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Um capítulo da tradução completa está disponível para download no formato simplificado.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * O número de versículos que o capítulo contém.
     */
    numberOfVerses: number;

    /**
     * Os links para as diferentes versões em áudio do capítulo.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Os tempos de áudio (início de cada verso, em segundos) para o capítulo.
     *
     * Note que os arquivos de tradução completos contêm as marcações de tempo (consulte TranslationBookChapterAudioTimingsMap na documentação do formato padrão), ao contrário dos pontos finais de capítulos individuais, que contêm links para elas.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * O link para as anotações em nível de palavra do capítulo, usando o formato simplificado. Omitido se o capítulo não tiver anotações em nível de palavra.
     */
    thisChapterWordsLink?: string;

    /**
     * Informações simplificadas para o capítulo.
     */
    chapter: SimpleChapterData;
}