Formato simplificado

export interface SimpleTranslationBookChapter {
    /**
     * Información sobre la traducción del capítulo del libro.
     */
    translation: Translation;

    /**
     * La información del libro correspondiente al capítulo del libro.
     */
    book: TranslationBook;

    /**
     * El enlace al capítulo actual.
     */
    thisChapterLink: string;

    /**
     * Enlace a la versión normal (no simplificada) de este capítulo.
     */
    fullChapterApiLink: string;

    /**
     * Los enlaces a las diferentes versiones de audio del capítulo.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Enlaces a los tiempos de audio para las diferentes versiones de audio del capítulo.
     * Consulte la sección "Obtener la sincronización de audio para un capítulo" en la documentación del formato estándar; el archivo de sincronización es el mismo independientemente del formato de capítulo al que esté vinculado.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * El enlace al siguiente capítulo, en formato simplificado.
     * Nulo si este es el último capítulo de la traducción.
     */
    nextChapterApiLink: string | null;

    /**
     * Enlaces a las diferentes versiones de audio del próximo capítulo.
     * Nulo si este es el último capítulo de la traducción.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Enlaces a la sincronización del audio para las diferentes versiones de audio del próximo capítulo.
     * Nulo si este es el último capítulo de la traducción.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * El enlace al capítulo anterior, en formato simplificado.
     * Nulo si este es el primer capítulo de la traducción.
     */
    previousChapterApiLink: string | null;

    /**
     * Enlaces a diferentes versiones de audio del capítulo anterior.
     * Nulo si este es el primer capítulo de la traducción.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Enlaces a la sincronización del audio para las diferentes versiones de audio del capítulo anterior.
     * Nulo si este es el primer capítulo de la traducción.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * El número de versículos que contiene el capítulo.
     */
    numberOfVerses: number;

    /**
     * La información del capítulo.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * El número del capítulo.
     */
    number: number;

    /**
     * El contenido del capítulo.
     */
    content: SimpleChapterContent[];

    /**
     * La lista de notas a pie de página que no pudieron asociarse con ningún versículo.
     * Las notas a pie de página que corresponden a un versículo se incluyen en el propio versículo, por lo que esta lista suele estar vacía.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Un tipo de unión que representa una sola pieza de contenido en un capítulo simplificado.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Un encabezado en un capítulo.
 */
interface SimpleChapterHeading {
    /**
     * Indica que el contenido representa un encabezado.
     */
    type: 'heading';

    /**
     * El texto del encabezado.
     */
    text: string;
}

/**
 * Un salto de línea en un capítulo.
 */
interface ChapterLineBreak {
    /**
     * Indica que el contenido representa un salto de línea.
     */
    type: 'line_break';
}

/**
 * Un versículo en un capítulo.
 */
interface SimpleChapterVerse {
    /**
     * Indica que el contenido es un versículo.
     */
    type: 'verse';

    /**
     * El número del versículo.
     */
    number: number;

    /**
     * El texto del versículo.
     * Los versos y los saltos de línea están separados por caracteres de nueva línea (\n).
     */
    text: string;

    /**
     * Las notas a pie de página que aparecen en el versículo.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Los encabezados que aparecen en medio del versículo.
     * Se omite si el versículo no contiene encabezados en línea.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Los rangos del texto del versículo que representan las Palabras de Jesús.
     * Se omite si el versículo no contiene ninguno.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Los rangos del texto en verso que representan versos de poesía.
     * Se omite si el versículo no contiene ninguno.
     */
    poem?: SimplePoemRange[];
}

/**
 * Un subtítulo en hebreo en un capítulo.
 * Estos elementos suelen incluirse como contenido informativo que aparecía en los manuscritos originales.
 * Por ejemplo, el Salmo 49 tiene el subtítulo en hebreo "Al director del coro. Salmo de los hijos de Coré".
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Indica que el contenido corresponde a un subtítulo en hebreo.
     */
    type: 'hebrew_subtitle';
}

/**
 * Una nota a pie de página en un verso.
 */
interface SimpleVerseFootnote {
    /**
     * El ID de la nota.
     */
    noteId: number;

    /**
     * El índice en el texto del versículo donde debe insertarse la nota al pie.
     */
    offset: number;

    /**
     * El texto de la nota al pie.
     */
    text: string;

    /**
     * La persona que realizó la llamada que debe utilizarse para la nota al pie.
     * Si es "+", entonces la persona que realiza la llamada debería generarse automáticamente.
     * Si es nulo, entonces el llamador debe estar vacío.
     * Si es una cadena, entonces quien realiza la llamada debe ser esa cadena.
     */
    caller: '+' | string | null;
}

/**
 * Un encabezado que está insertado en un verso.
 */
interface SimpleInlineHeading {
    /**
     * El índice en el texto del versículo donde aparece el encabezado.
     */
    offset: number;

    /**
     * El texto del encabezado.
     */
    text: string;
}

/**
 * Un fragmento de texto dentro de un verso.
 */
interface SimpleTextRange {
    /**
     * El índice del primer carácter del rango.
     */
    start: number;

    /**
     * El índice que sigue al último carácter del rango.
     */
    end: number;
}

/**
 * Un fragmento de texto dentro de un verso que representa una línea de poesía.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * El grado de sangría con el que debe mostrarse el verso.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * El ID de la traducción.
     */
    translationId: string;

    /**
     * La identificación del libro.
     */
    bookId: string;

    /**
     * El número del capítulo.
     */
    chapterNumber: number;

    /**
     * Enlace al capítulo simplificado al que corresponden estas anotaciones.
     */
    thisChapterLink: string;

    /**
     * Enlace al siguiente capítulo simplificado.
     * Nulo si este es el último capítulo de la traducción.
     */
    nextChapterLink: string | null;

    /**
     * Enlace al capítulo simplificado anterior.
     * Nulo si este es el primer capítulo de la traducción.
     */
    previousChapterLink: string | null;

    /**
     * El enlace a estas anotaciones.
     */
    thisChapterWordsLink: string;

    /**
     * Enlace a las anotaciones del próximo capítulo.
     * Nulo si este es el último capítulo de la traducción, o si el siguiente capítulo no tiene anotaciones a nivel de palabra.
     */
    nextChapterWordsLink: string | null;

    /**
     * Enlace a las anotaciones del capítulo anterior.
     * Nulo si este es el primer capítulo de la traducción, o si el capítulo anterior no tiene anotaciones a nivel de palabra.
     */
    previousChapterWordsLink: string | null;

    /**
     * Las palabras anotadas para cada versículo del capítulo, indicadas por el número del versículo.
     * Cada lista está en el orden en que aparecen las palabras en el versículo.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Una anotación a nivel de palabra en un capítulo simplificado.
 */
export interface SimpleChapterWord {
    /**
     * El índice del primer carácter de la palabra anotada en el texto del verso.
     */
    start: number;

    /**
     * El índice que aparece después del último carácter de la palabra anotada en el texto del verso.
     */
    end: number;

    /**
     * Los números de Strong para la palabra.
     */
    strongs?: string[];

    /**
     * El lema (forma diccionaria) de la palabra en el idioma de origen.
     */
    lemma?: string;

    /**
     * La morfología de la palabra en el idioma de origen.
     */
    morph?: string;

    /**
     * La ubicación de la palabra en el texto original.
     */
    srcloc?: string;

    /**
     * ¿Cuál es la aparición de esta palabra en el versículo?
     */
    occurrence?: number;

    /**
     * El número de veces que aparece la palabra en el versículo.
     */
    occurrences?: number;
}

/**
 * Define los datos completos de descarga de la traducción, utilizando el formato de capítulo simplificado.
 * Se corresponde con el punto final /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * Los metadatos de la traducción.
     */
    translation: Translation;

    /**
     * La lista completa de libros con todos sus capítulos.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Descarga del libro en su traducción completa, utilizando el formato de capítulos simplificado.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * La lista completa de capítulos con todo su contenido.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Un capítulo de la descarga de la traducción completa, utilizando el formato de capítulo simplificado.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * El número de versículos que contiene el capítulo.
     */
    numberOfVerses: number;

    /**
     * Los enlaces a las diferentes versiones de audio del capítulo.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Los tiempos de audio (tiempos de inicio por verso, en segundos) para el capítulo.
     *
     * Tenga en cuenta que los archivos de traducción completos contienen las indicaciones de tiempo (consulte TranslationBookChapterAudioTimingsMap en la documentación del formato estándar), a diferencia de los puntos finales de los capítulos individuales, que contienen enlaces a ellos.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Enlace a las anotaciones a nivel de palabra del capítulo, en formato simplificado. Se omite si el capítulo no contiene anotaciones a nivel de palabra.
     */
    thisChapterWordsLink?: string;

    /**
     * Información simplificada para el capítulo.
     */
    chapter: SimpleChapterData;
}