Formato padrão

export interface TranslationBookChapter {
    /**
     * 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;

    /**
     * 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.
     * Cada link direciona para o arquivo de sincronização de áudio daquele leitor - veja "Obter a sincronização de áudio de um capítulo" abaixo.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * O link para o próximo capítulo.
     * 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.
     * 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 link para as anotações em nível de palavra do capítulo.
     * Omitido se o capítulo não tiver anotações em nível de palavra.
     */
    thisChapterWordsLink?: string;

    /**
     * O link para as anotações em nível de palavra do próximo capítulo.
     * (Omitido se este for o último capítulo da tradução ou se o próximo capítulo não tiver anotações ao nível das palavras.)
     */
    nextChapterWordsLink?: string;

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

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

    /**
     * O link para a versão simplificada deste capítulo.
     * Omitido se capítulos simplificados não estiverem disponíveis.
     */
    simpleChapterApiLink?: string;

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

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

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

    /**
     * Lista de notas de rodapé do capítulo.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Um tipo de união que representa um único trecho do conteúdo de um capítulo.
 * Um trecho do conteúdo de um capítulo pode ser uma das seguintes coisas:
 * - Um título.
 * - Uma quebra de linha.
 * — Um verso.
 * - Legendas em hebraico.
 */
type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

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

    /**
     * O conteúdo do título.
     * Se várias strings estiverem incluídas na matriz, elas devem ser concatenadas com um espaço.
     */
    content: string[];
}

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

/**
 * Legenda em hebraico em um capítulo.
 * Esses elementos são frequentemente utilizados 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 ChapterHebrewSubtitle {
    /**
     * Indica que o conteúdo representa uma legenda em hebraico.
     */
    type: 'hebrew_subtitle';

    /**
     * A lista de conteúdo que está contido na legenda.
     * Cada elemento da lista pode ser uma cadeia de caracteres, um texto formatado ou uma referência de nota de rodapé.
     */
    content: (string | FormattedText | VerseFootnoteReference)[];
}

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

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

    /**
     * Lista de conteúdo do versículo.
     * Cada elemento da lista pode ser uma cadeia de caracteres, um texto formatado ou uma referência de nota de rodapé.
     */
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

/**
 * Texto formatado. Ou seja, texto que está formatado de uma maneira específica.
 */
interface FormattedText {
    /**
     * O texto que está formatado.
     */
    text: string;

    /**
     * Se o texto representa um poema.
     * O número indica o nível de recuo.
     *
     * Comum nos Salmos.
     */
    poem?: number;

    /**
     * Se o texto representa as palavras de Jesus.
     */
    wordsOfJesus?: boolean;
}

/**
 * Define uma interface que representa um título inserido em um versículo.
 */
interface InlineHeading {
    /**
     * O texto do título.
     */
    heading: string;
}

/**
 * Define uma interface que representa uma quebra de linha inserida em um verso.
 */
interface InlineLineBreak {
    lineBreak: true;
}


/**
 * Uma referência em nota de rodapé em um versículo ou um subtítulo em hebraico.
 */
interface VerseFootnoteReference {
    /**
     * O ID da nota.
     */
    noteId: number;
}

/**
 * Informações sobre uma nota de rodapé.
 */
interface ChapterFootnote {
    /**
     * O ID da nota referenciada.
     */
    noteId: number;

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

    /**
     * A referência bíblica para a nota de rodapé.
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * O identificador que deve ser usado para a nota de rodapé.
     * Em notas de rodapé, um "caractere de chamada" é o caractere usado no texto para fazer referência à nota de rodapé.
     *
     * Por exemplo, no texto:
     * Olá (a) Mundo
     *
     * ---- (a) Esta é uma nota de rodapé.
     *
     * O "(a)" é o chamador.
     *
     * 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;
}

/**
 * Os links de áudio para um capítulo do livro.
 */
interface TranslationBookChapterAudioLinks {
    /**
     * O texto de apresentação do capítulo e o link URL para o arquivo de áudio.
     */
    [reader: string]: string;
}

/**
 * Os links para os tempos de áudio de um capítulo do livro.
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * O leitor do capítulo e o link da API para o arquivo de sincronização de áudio desse leitor.
     */
    [reader: string]: string;
}

/**
 * Define a duração do áudio para um capítulo de livro, para um único narrador.
 * Mapeia para o endpoint /api/{translation}/{book}/{chapter}.{reader}.audioTimings.json.
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * O ID da tradução.
     */
    translationId: string;

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

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

    /**
     * O ID do leitor ao qual esses horários se referem.
     */
    reader: string;

    /**
     * O link para o arquivo de áudio ao qual se referem esses tempos.
     */
    audioLink: string;

    /**
     * O link para as informações deste capítulo.
     */
    thisChapterLink: string;

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

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

    /**
     * O link para este arquivo de sincronização de áudio.
     */
    thisChapterAudioTimingsLink: string;

    /**
     * O link para os horários do próximo capítulo, para o mesmo leitor.
     * Nulo se este for o último capítulo da tradução.
     */
    nextChapterAudioTimingsLink: string | null;

    /**
     * O link para os horários do capítulo anterior, para o mesmo leitor.
     * Nulo se este for o primeiro capítulo da tradução.
     */
    previousChapterAudioTimingsLink: string | null;

    /**
     * Os instantes em segundos em que cada verso começa, em ordem.
     * O primeiro número (índice 0) indica o momento na gravação em que começa o primeiro verso.
     */
    verses: number[];
}

export interface TranslationBookChapterWords {
    /**
     * 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 as informações deste capítulo.
     */
    thisChapterLink: string;

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

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

    /**
     * O link para este arquivo de palavras.
     */
    thisChapterWordsLink: string;

    /**
     * O link para o texto 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 o texto 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]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * O índice do item na matriz de conteúdo do versículo ao qual a anotação se aplica.
     */
    contentIndex: number;

    /**
     * O índice do primeiro caractere da palavra anotada no texto do item de conteúdo.
     */
    start: number;

    /**
     * O índice que se encontra após o último caractere da palavra anotada no texto do item de conteúdo.
     * Ou seja, text.slice(start, end) é a palavra anotada.
     */
    end: number;

    /**
     * Número(s) de Strong para a palavra.
     * Omitido se a tradução forneceu apenas outras anotações para a palavra.
     */
    strongs?: string[];

    /**
     * A forma da palavra citada no dicionário.
     * Omitido se a tradução não a forneceu.
     */
    lemma?: string;

    /**
     * O código de análise morfológica da palavra.
     * Omitido se a tradução não a forneceu.
     */
    morph?: string;

    /**
     * O ponteiro para a palavra no texto fonte, no formato <sourceName> : <location> .
     * Omitido se a tradução não a forneceu.
     */
    srcloc?: string;

    /**
     * Qual ocorrência da palavra-fonte é esta palavra? Baseada em 1.
     * Omitido se a tradução não a forneceu.
     */
    occurrence?: number;

    /**
     * O número total de vezes que a palavra-fonte ocorre.
     * Omitido se a tradução não a forneceu.
     */
    occurrences?: number;
}

/**
 * Define os dados completos de download da tradução.
 * Mapeia para o endpoint /api/:translationId/complete.json.
 */
export interface TranslationComplete {
    /**
     * Os metadados da tradução.
     */
    translation: Translation;

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

/**
 * Baixe o livro na íntegra, com a tradução completa.
 */
export interface TranslationCompleteBook {
    /**
     * A identificação do livro.
     */
    id: string;

    /**
     * O nome do livro, conforme a tradução.
     */
    name: string;

    /**
     * Nome comum do livro.
     */
    commonName: string;

    /**
     * O título do livro.
     */
    title: string | null;

    /**
     * A ordem do livro.
     */
    order: number;

    /**
     * O número de capítulos do livro.
     */
    numberOfChapters: number;

    /**
     * O número total de versículos no livro.
     */
    totalNumberOfVerses: number;

    /**
     * Se o livro é apócrifo.
     */
    isApocryphal?: boolean;

    /**
     * Lista completa dos capítulos com todo o conteúdo.
     */
    chapters: TranslationCompleteChapter[];
}

/**
 * Um capítulo no download da tradução completa.
 */
export interface TranslationCompleteChapter {
    /**
     * 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 (horários de início de cada verso, em segundos) para diferentes versões de áudio do capítulo.
     *
     * Ao contrário do item `thisChapterAudioTimings` no endpoint de cada capítulo individual (que leva a "Obter a sincronização de áudio de um capítulo" abaixo), este contém a própria sincronização - já que o objetivo do download da tradução completa é ter tudo em um único arquivo.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

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

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

/**
 * A duração do áudio de um capítulo do livro, incorporada diretamente em vez de por meio de um link.
 * Mapeia um ID de leitor para a lista de horários (em segundos) em que cada versículo começa, na ordem dos versículos.
 */
interface TranslationBookChapterAudioTimingsMap {
    [reader: string]: number[];
}