Упрощенный формат

export interface SimpleTranslationBookChapter {
    /**
     * Информация для перевода главы книги.
     */
    translation: Translation;

    /**
     * Информация о книге, относящаяся к данной главе.
     */
    book: TranslationBook;

    /**
     * Ссылка на текущую главу.
     */
    thisChapterLink: string;

    /**
     * Ссылка на обычную (неупрощенную) версию этой главы.
     */
    fullChapterApiLink: string;

    /**
     * Ссылки на различные аудиоверсии главы.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Ссылки на временные параметры различных аудиоверсий главы.
     * См. раздел "Получение временных параметров аудио для главы" в документации по стандартному формату — файл с временными параметрами одинаков независимо от того, к какому формату главы он привязан.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Ссылка на следующую главу в упрощенном формате.
     * Если это последняя глава в переводе, значение должно быть равно нулю.
     */
    nextChapterApiLink: string | null;

    /**
     * Ссылки на различные аудиоверсии следующей главы.
     * Если это последняя глава в переводе, значение должно быть равно нулю.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Ссылки на временные параметры различных аудиоверсий для следующей главы.
     * Если это последняя глава в переводе, значение должно быть равно нулю.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Ссылка на предыдущую главу в упрощенном формате.
     * Если это первая глава в переводе, значение должно быть равно нулю.
     */
    previousChapterApiLink: string | null;

    /**
     * Ссылки на различные аудиоверсии предыдущей главы.
     * Если это первая глава в переводе, значение должно быть равно нулю.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Ссылки на временные параметры различных аудиоверсий из предыдущей главы.
     * Если это первая глава в переводе, значение должно быть равно нулю.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Количество стихов, содержащихся в главе.
     */
    numberOfVerses: number;

    /**
     * Информация для данной главы.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * Номер главы.
     */
    number: number;

    /**
     * Содержание главы.
     */
    content: SimpleChapterContent[];

    /**
     * Список сносок, которые не удалось связать со стихом.
     * Сноски, относящиеся к стиху, указываются непосредственно в самом стихе, поэтому этот список обычно пуст.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Тип объединения, представляющий собой отдельный фрагмент контента в упрощенной главе.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Заголовок в главе.
 */
interface SimpleChapterHeading {
    /**
     * Указывает на то, что содержимое представляет собой заголовок.
     */
    type: 'heading';

    /**
     * Текст заголовка.
     */
    text: string;
}

/**
 * Разрыв строки в главе.
 */
interface ChapterLineBreak {
    /**
     * Указывает, что содержимое представляет собой перенос строки.
     */
    type: 'line_break';
}

/**
 * Один стих в главе.
 */
interface SimpleChapterVerse {
    /**
     * Указывает на то, что содержание представляет собой стих.
     */
    type: 'verse';

    /**
     * Номер стиха.
     */
    number: number;

    /**
     * Текст стиха.
     * Строки стихов и переносы строк разделяются символами новой строки (\n).
     */
    text: string;

    /**
     * Сноски, встречающиеся в стихе.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Заголовки, расположенные в середине стиха.
     * Опускается, если в тексте стиха отсутствуют заголовки.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Диапазоны стихов, представляющие собой слова Иисуса.
     * Опускается, если в стихе нет ни одного слова.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Диапазоны стихотворного текста, представляющие собой строки поэзии.
     * Опускается, если в стихе нет ни одного слова.
     */
    poem?: SimplePoemRange[];
}

/**
 * Субтитры на иврите в одной из глав.
 * Зачастую они включаются в качестве информационного контента, который присутствовал в оригинальных рукописях.
 * Например, 49-й псалом имеет еврейский подзаголовок: «Начальнику хора. Псалом сынов Кораха».
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Указывает на то, что контент представляет собой субтитры на иврите.
     */
    type: 'hebrew_subtitle';
}

/**
 * Сноска в стихе.
 */
interface SimpleVerseFootnote {
    /**
     * Идентификатор записки.
     */
    noteId: number;

    /**
     * Укажите в тексте стихотворения индекс, на котором следует разместить ссылку на источник.
     */
    offset: number;

    /**
     * Текст сноски.
     */
    text: string;

    /**
     * Адрес, указанный в сноске.
     * Если стоит знак "+", то вызывающий объект должен быть сгенерирован автоматически.
     * Если значение равно null, то вызывающий объект должен быть пустым.
     * Если это строка, то вызывающей стороной должна быть эта строка.
     */
    caller: '+' | string | null;
}

/**
 * Заголовок, встроенный в стихотворение.
 */
interface SimpleInlineHeading {
    /**
     * Указатель в тексте стихотворения, где встречается данный заголовок.
     */
    offset: number;

    /**
     * Текст заголовка.
     */
    text: string;
}

/**
 * Текстовый фрагмент внутри стихотворения.
 */
interface SimpleTextRange {
    /**
     * Индекс первого символа диапазона.
     */
    start: number;

    /**
     * Индекс, следующий за последним символом диапазона.
     */
    end: number;
}

/**
 * Текстовый фрагмент внутри стихотворения, представляющий собой строку поэзии.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Уровень отступа, с которым должна отображаться строка стихотворения.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * Идентификатор перевода.
     */
    translationId: string;

    /**
     * Идентификатор книги.
     */
    bookId: string;

    /**
     * Номер главы.
     */
    chapterNumber: number;

    /**
     * Ссылка на упрощенную главу, к которой относятся эти примечания.
     */
    thisChapterLink: string;

    /**
     * Ссылка на следующую упрощенную главу.
     * Если это последняя глава в переводе, значение должно быть равно нулю.
     */
    nextChapterLink: string | null;

    /**
     * Ссылка на предыдущую упрощенную главу.
     * Если это первая глава в переводе, значение должно быть равно нулю.
     */
    previousChapterLink: string | null;

    /**
     * Ссылка на эти аннотации.
     */
    thisChapterWordsLink: string;

    /**
     * Ссылка на комментарии к следующей главе.
     * Значение null, если это последняя глава перевода или если следующая глава не содержит пояснений на уровне слов.
     */
    nextChapterWordsLink: string | null;

    /**
     * Ссылка на комментарии к предыдущей главе.
     * Значение null, если это первая глава перевода или если в предыдущей главе отсутствуют пояснения к словам.
     */
    previousChapterWordsLink: string | null;

    /**
     * Аннотированные слова для каждого стиха в главе, с указанием номера стиха.
     * Каждый список составлен в порядке появления слов в стихе.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Аннотация на уровне отдельных слов в упрощенной главе.
 */
export interface SimpleChapterWord {
    /**
     * Индекс первого символа аннотированного слова в тексте стиха.
     */
    start: number;

    /**
     * Указатель, следующий за последней буквой аннотированного слова в тексте стиха.
     */
    end: number;

    /**
     * Числа Стронга для этого слова.
     */
    strongs?: string[];

    /**
     * Лемма (словарная форма) слова в языке-источнике.
     */
    lemma?: string;

    /**
     * Морфология слова в языке-источнике.
     */
    morph?: string;

    /**
     * Местоположение слова в исходном тексте.
     */
    srcloc?: string;

    /**
     * В каком именно месте этого стиха встречается данное слово?
     */
    occurrence?: number;

    /**
     * Количество раз, которое это слово встречается в стихе.
     */
    occurrences?: number;
}

/**
 * Определяет полный набор данных для загрузки перевода, используя упрощенный формат глав.
 * Сопоставляется с конечной точкой /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * Метаданные перевода.
     */
    translation: Translation;

    /**
     * Полный список книг со всеми их главами.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Книга в полном переводе, доступная для скачивания, с использованием упрощенного формата глав.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * Полный список глав со всем содержанием.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Одна из глав полного перевода, доступного для скачивания, в упрощенном формате.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * Количество стихов, содержащихся в главе.
     */
    numberOfVerses: number;

    /**
     * Ссылки на различные аудиоверсии главы.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Продолжительность аудиозаписи (время начала каждого куплета в секундах) для данной главы.
     *
     * Обратите внимание, что полные файлы перевода содержат сами временные параметры (см. TranslationBookChapterAudioTimingsMap в документации по стандартному формату), в отличие от отдельных конечных точек глав, которые содержат ссылки на них.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Ссылка на пояснения к главе в упрощенном формате. Опускается, если глава не содержит пояснений.
     */
    thisChapterWordsLink?: string;

    /**
     * Упрощенная информация к главе.
     */
    chapter: SimpleChapterData;
}