Стандартный формат

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

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

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

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

    /**
     * Ссылки на временные параметры различных аудиоверсий главы.
     * Каждая ссылка ведет к файлу с данными о времени воспроизведения аудио для соответствующего читателя — см. раздел «Получить данные о времени воспроизведения аудио для главы» ниже.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

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

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

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

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

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

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

    /**
     * Ссылка на пояснения к главе на уровне отдельных слов.
     * Опускается, если в главе отсутствуют пояснения на уровне слов.
     */
    thisChapterWordsLink?: string;

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

    /**
     * Ссылка на аннотации к предыдущему разделу (на уровне слов).
     * Эта аннотация опущена, если это первая глава перевода или если в предыдущей главе отсутствуют пояснения к отдельным словам.
     */
    previousChapterWordsLink?: string;

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

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

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

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

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

    /**
     * Список сносок к главе.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Тип объединения, представляющий собой отдельный фрагмент содержимого главы.
 * Содержание главы может представлять собой один из следующих элементов:
 * - Заголовок.
 * - Разрыв строки.
 * — Стих.
 * — Субтитры на иврите.
 */
type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

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

    /**
     * Содержание заголовка.
     * Если массив содержит несколько строк, их следует объединить пробелом.
     */
    content: string[];
}

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

/**
 * Субтитры на иврите в одной из глав.
 * Эти материалы часто используются в качестве информационного контента, который присутствовал в оригинальных рукописях.
 * Например, 49-й псалом имеет еврейский подзаголовок: «Начальнику хора. Псалом сынов Кораха».
 */
interface ChapterHebrewSubtitle {
    /**
     * Указывает на то, что контент представляет собой субтитры на иврите.
     */
    type: 'hebrew_subtitle';

    /**
     * Список содержимого, указанного в подзаголовке.
     * Каждый элемент в списке может представлять собой строку, отформатированный текст или ссылку на сноску.
     */
    content: (string | FormattedText | VerseFootnoteReference)[];
}

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

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

    /**
     * Список содержания стиха.
     * Каждый элемент в списке может представлять собой строку, отформатированный текст или ссылку на сноску.
     */
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

/**
 * Форматированный текст. То есть текст, отформатированный определенным образом.
 */
interface FormattedText {
    /**
     * Отформатированный текст.
     */
    text: string;

    /**
     * Является ли данный текст стихотворением.
     * Число указывает уровень отступа.
     *
     * Часто встречается в псалмах.
     */
    poem?: number;

    /**
     * Соответствует ли текст словам Иисуса?
     */
    wordsOfJesus?: boolean;
}

/**
 * Определяет интерфейс, представляющий заголовок, встроенный в стихотворение.
 */
interface InlineHeading {
    /**
     * Текст заголовка.
     */
    heading: string;
}

/**
 * Определяет интерфейс, представляющий собой перенос строки, встроенный в текст стиха.
 */
interface InlineLineBreak {
    lineBreak: true;
}


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

/**
 * Информация о сноске.
 */
interface ChapterFootnote {
    /**
     * Идентификатор примечания, на которое делается ссылка.
     */
    noteId: number;

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

    /**
     * Стихотворная ссылка для сноски.
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * Адрес, указанный в сноске.
     * В случае сносок, «вызывающий символ» — это символ, используемый в тексте для ссылки на сноску.
     *
     * Например, в тексте:
     * Привет, мир!
     *
     * ---- (a) Это сноска.
     *
     * "(a)" обозначает вызывающего абонента.
     *
     * Если стоит знак "+", то вызывающий объект должен быть сгенерирован автоматически.
     * Если значение равно null, то вызывающий объект должен быть пустым.
     * Если это строка, то вызывающей стороной должна быть эта строка.
     */
    caller: '+' | string | null;
}

/**
 * Аудиоссылки на главы книги.
 */
interface TranslationBookChapterAudioLinks {
    /**
     * Список чтецов для главы и ссылка на аудиофайл.
     */
    [reader: string]: string;
}

/**
 * Ссылки на аудиозаписи глав книги.
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * Для чтения главы указан текст, а также ссылка API на файл с временными параметрами аудиозаписи для этого текстового редактора.
     */
    [reader: string]: string;
}

/**
 * Задает продолжительность аудиосопровождения главы книги для одного читателя.
 * Сопоставляется с конечной точкой /api/{translation}/{book}/{chapter}.{reader}.audioTimings.json.
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * Идентификатор перевода.
     */
    translationId: string;

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

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

    /**
     * Идентификатор считывателя, для которого предназначены эти временные параметры.
     */
    reader: string;

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

    /**
     * Ссылка на информацию по данной главе.
     */
    thisChapterLink: string;

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

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

    /**
     * Ссылка на этот аудиофайл с временными параметрами.
     */
    thisChapterAudioTimingsLink: string;

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

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

    /**
     * Время начала каждого куплета в секундах, в порядке следования.
     * Первая цифра (индекс 0) обозначает момент времени в записи, с которого начинается первый куплет.
     */
    verses: number[];
}

export interface TranslationBookChapterWords {
    /**
     * Идентификатор перевода.
     */
    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]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * Индекс элемента в массиве содержимого стиха, к которому относится аннотация.
     */
    contentIndex: number;

    /**
     * Индекс первого символа аннотированного слова в тексте элемента контента.
     */
    start: number;

    /**
     * Индекс, следующий за последним символом аннотированного слова в тексте элемента контента.
     * То есть, text.slice(start, end) — это аннотированное слово.
     */
    end: number;

    /**
     * Номер (номера) слова по Стронгу.
     * Опускается, если перевод содержал только дополнительные пояснения к слову.
     */
    strongs?: string[];

    /**
     * Словарная (цитационная) форма слова.
     * Если в переводе такой опции не было, она опущена.
     */
    lemma?: string;

    /**
     * Морфологический код разбора слова.
     * Если в переводе такой опции не было, она опущена.
     */
    morph?: string;

    /**
     * Указатель на слово в исходном тексте в формате <sourceName> : <location> .
     * Если в переводе такой опции не было, она опущена.
     */
    srcloc?: string;

    /**
     * В каком случае исходного слова встречается это слово? 1-основано.
     * Если в переводе такой опции не было, она опущена.
     */
    occurrence?: number;

    /**
     * Общее количество вхождений исходного слова.
     * Если в переводе такой опции не было, она опущена.
     */
    occurrences?: number;
}

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

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

/**
 * Книга в полном переводе (скачать).
 */
export interface TranslationCompleteBook {
    /**
     * Идентификатор книги.
     */
    id: string;

    /**
     * Название книги из перевода.
     */
    name: string;

    /**
     * Общепринятое название книги.
     */
    commonName: string;

    /**
     * Название книги.
     */
    title: string | null;

    /**
     * Порядок книг.
     */
    order: number;

    /**
     * Количество глав в книге.
     */
    numberOfChapters: number;

    /**
     * Общее количество стихов в книге.
     */
    totalNumberOfVerses: number;

    /**
     * Является ли эта книга апокрифической.
     */
    isApocryphal?: boolean;

    /**
     * Полный список глав со всем содержанием.
     */
    chapters: TranslationCompleteChapter[];
}

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

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

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

    /**
     * Ссылка на пояснения к главе на уровне отдельных слов.
     * Опускается, если в главе отсутствуют пояснения на уровне слов.
     */
    thisChapterWordsLink?: string;

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

/**
 * Продолжительность аудиосопровождения главы книги, встроенная непосредственно в текст, а не по ссылке.
 * Сопоставляет идентификатор читателя со списком временных меток (в секундах), с которых начинается каждый куплет, в порядке следования стихов.
 */
interface TranslationBookChapterAudioTimingsMap {
    [reader: string]: number[];
}