Simplified Format

export interface SimpleTranslationBookChapter {
    /**
     * The translation information for the book chapter.
     */
    translation: Translation;

    /**
     * The book information for the book chapter.
     */
    book: TranslationBook;

    /**
     * The link to the current chapter.
     */
    thisChapterLink: string;

    /**
     * The link to the regular (non-simplified) version of this chapter.
     */
    fullChapterApiLink: string;

    /**
     * The links to different audio versions for the chapter.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * The link to the next chapter, in the simplified format.
     * Null if this is the last chapter in the translation.
     */
    nextChapterApiLink: string | null;

    /**
     * The links to different audio versions for the next chapter.
     * Null if this is the last chapter in the translation.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * The link to the previous chapter, in the simplified format.
     * Null if this is the first chapter in the translation.
     */
    previousChapterApiLink: string | null;

    /**
     * The links to different audio versions for the previous chapter.
     * Null if this is the first chapter in the translation.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * The number of verses that the chapter contains.
     */
    numberOfVerses: number;

    /**
     * The information for the chapter.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * The number of the chapter.
     */
    number: number;

    /**
     * The content of the chapter.
     */
    content: SimpleChapterContent[];

    /**
     * The list of footnotes that could not be associated with a verse.
     * Footnotes that belong to a verse are included on the verse itself,
     * so this list is usually empty.
     */
    footnotes: ChapterFootnote[];
}

/**
 * A union type that represents a single piece of content in a simplified chapter.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * A heading in a chapter.
 */
interface SimpleChapterHeading {
    /**
     * Indicates that the content represents a heading.
     */
    type: 'heading';

    /**
     * The text of the heading.
     */
    text: string;
}

/**
 * A line break in a chapter.
 */
interface ChapterLineBreak {
    /**
     * Indicates that the content represents a line break.
     */
    type: 'line_break';
}

/**
 * A verse in a chapter.
 */
interface SimpleChapterVerse {
    /**
     * Indicates that the content is a verse.
     */
    type: 'verse';

    /**
     * The number of the verse.
     */
    number: number;

    /**
     * The text of the verse.
     * Lines of poetry and line breaks are separated by newline (\n) characters.
     */
    text: string;

    /**
     * The footnotes that occur in the verse.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * The headings that occur in the middle of the verse.
     * Omitted if the verse contains no inline headings.
     */
    headings?: SimpleInlineHeading[];

    /**
     * The ranges of the verse text that represent the Words of Jesus.
     * Omitted if the verse contains none.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * The ranges of the verse text that represent lines of poetry.
     * Omitted if the verse contains none.
     */
    poem?: SimplePoemRange[];
}

/**
 * A Hebrew Subtitle in a chapter.
 * These are often included as informational content that appeared in the original manuscripts.
 * For example, Psalms 49 has the Hebrew Subtitle "To the choirmaster. A Psalm of the Sons of Korah."
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Indicates that the content represents a Hebrew Subtitle.
     */
    type: 'hebrew_subtitle';
}

/**
 * A footnote in a verse.
 */
interface SimpleVerseFootnote {
    /**
     * The ID of the note.
     */
    noteId: number;

    /**
     * The index in the verse text that the footnote caller should be inserted at.
     */
    offset: number;

    /**
     * The text of the footnote.
     */
    text: string;

    /**
     * The caller that should be used for the footnote.
     * If "+", then the caller should be autogenerated.
     * If null, then the caller should be empty.
     * If a string, then the caller should be that string.
     */
    caller: '+' | string | null;
}

/**
 * A heading that is embedded in a verse.
 */
interface SimpleInlineHeading {
    /**
     * The index in the verse text that the heading occurs at.
     */
    offset: number;

    /**
     * The text of the heading.
     */
    text: string;
}

/**
 * A range of text inside a verse.
 */
interface SimpleTextRange {
    /**
     * The index of the first character of the range.
     */
    start: number;

    /**
     * The index after the last character of the range.
     */
    end: number;
}

/**
 * A range of text inside a verse that represents a line of poetry.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * The level of indent that the line of poetry should be displayed with.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * The ID of the translation.
     */
    translationId: string;

    /**
     * The ID of the book.
     */
    bookId: string;

    /**
     * The number of the chapter.
     */
    chapterNumber: number;

    /**
     * The link to the simplified chapter that these annotations are for.
     */
    thisChapterLink: string;

    /**
     * The link to the next simplified chapter.
     * Null if this is the last chapter in the translation.
     */
    nextChapterLink: string | null;

    /**
     * The link to the previous simplified chapter.
     * Null if this is the first chapter in the translation.
     */
    previousChapterLink: string | null;

    /**
     * The link to these annotations.
     */
    thisChapterWordsLink: string;

    /**
     * The link to the annotations for the next chapter.
     * Null if this is the last chapter in the translation, or if the next chapter
     * doesn't have any word-level annotations.
     */
    nextChapterWordsLink: string | null;

    /**
     * The link to the annotations for the previous chapter.
     * Null if this is the first chapter in the translation, or if the previous
     * chapter doesn't have any word-level annotations.
     */
    previousChapterWordsLink: string | null;

    /**
     * The annotated words for each verse in the chapter, keyed by verse number.
     * Each list is in the order that the words occur in the verse.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * A word-level annotation in a simplified chapter.
 */
export interface SimpleChapterWord {
    /**
     * The index of the first character of the annotated word in the verse text.
     */
    start: number;

    /**
     * The index after the last character of the annotated word in the verse text.
     */
    end: number;

    /**
     * The Strong's numbers for the word.
     */
    strongs?: string[];

    /**
     * The lemma (dictionary form) of the word in the source language.
     */
    lemma?: string;

    /**
     * The morphology of the word in the source language.
     */
    morph?: string;

    /**
     * The location of the word in the source text.
     */
    srcloc?: string;

    /**
     * Which occurrence of the word in the verse this is.
     */
    occurrence?: number;

    /**
     * The number of times that the word occurs in the verse.
     */
    occurrences?: number;
}

/**
 * Defines the complete translation download data, using the simplified chapter format.
 * Maps to the /api/:translationId/complete.simple.json endpoint.
 */
export interface SimpleTranslationComplete {
    /**
     * The translation metadata.
     */
    translation: Translation;

    /**
     * The complete list of books with all their chapters.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * A book in the complete translation download, using the simplified chapter format.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * The complete list of chapters with all content.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * A chapter in the complete translation download, using the simplified chapter format.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * The number of verses that the chapter contains.
     */
    numberOfVerses: number;

    /**
     * The links to different audio versions for the chapter.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * The audio timings (per-verse start times, in seconds) for the chapter.
     *
     * Note that the complete translation files contain the timings themselves,
     * unlike the individual chapter endpoints, which contain links to them.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimings;

    /**
     * The simplified information for the chapter.
     */
    chapter: SimpleChapterData;
}