Format Sederhana

export interface SimpleTranslationBookChapter {
    /**
     * Informasi terjemahan untuk bab buku tersebut.
     */
    translation: Translation;

    /**
     * Informasi buku untuk bab buku tersebut.
     */
    book: TranslationBook;

    /**
     * Tautan ke bab saat ini.
     */
    thisChapterLink: string;

    /**
     * Tautan ke versi reguler (bukan versi sederhana) dari bab ini.
     */
    fullChapterApiLink: string;

    /**
     * Berikut tautan ke berbagai versi audio untuk bab ini.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Berikut tautan ke pengaturan waktu audio untuk berbagai versi audio bab ini.
     * Lihat "Mendapatkan Pengaturan Waktu Audio untuk Suatu Bab" di dokumen format standar - file pengaturan waktu akan sama terlepas dari format bab mana yang ditautkan kepadanya.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Tautan ke bab berikutnya, dalam format yang disederhanakan.
     * Bernilai null jika ini adalah bab terakhir dalam terjemahan.
     */
    nextChapterApiLink: string | null;

    /**
     * Berikut tautan ke berbagai versi audio untuk bab selanjutnya.
     * Bernilai null jika ini adalah bab terakhir dalam terjemahan.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Berikut tautan ke pengaturan waktu audio untuk berbagai versi audio untuk bab berikutnya.
     * Bernilai null jika ini adalah bab terakhir dalam terjemahan.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Tautan ke bab sebelumnya, dalam format yang disederhanakan.
     * Bernilai null jika ini adalah bab pertama dalam terjemahan.
     */
    previousChapterApiLink: string | null;

    /**
     * Berikut tautan ke berbagai versi audio untuk bab sebelumnya.
     * Bernilai null jika ini adalah bab pertama dalam terjemahan.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Berikut tautan ke pengaturan waktu audio untuk berbagai versi audio dari bab sebelumnya.
     * Bernilai null jika ini adalah bab pertama dalam terjemahan.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Jumlah ayat yang terdapat dalam bab tersebut.
     */
    numberOfVerses: number;

    /**
     * Informasi untuk bab ini.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * Nomor bab.
     */
    number: number;

    /**
     * Isi bab tersebut.
     */
    content: SimpleChapterContent[];

    /**
     * Daftar catatan kaki yang tidak dapat dikaitkan dengan sebuah ayat.
     * Catatan kaki yang berkaitan dengan suatu ayat disertakan pada ayat itu sendiri, sehingga daftar ini biasanya kosong.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Tipe gabungan yang mewakili satu bagian konten dalam bab yang disederhanakan.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Judul dalam sebuah bab.
 */
interface SimpleChapterHeading {
    /**
     * Menunjukkan bahwa konten tersebut merupakan sebuah judul.
     */
    type: 'heading';

    /**
     * Teks judul.
     */
    text: string;
}

/**
 * Jeda baris dalam sebuah bab.
 */
interface ChapterLineBreak {
    /**
     * Menunjukkan bahwa konten tersebut merupakan jeda baris.
     */
    type: 'line_break';
}

/**
 * Sebuah ayat dalam sebuah pasal.
 */
interface SimpleChapterVerse {
    /**
     * Menunjukkan bahwa isinya adalah sebuah ayat.
     */
    type: 'verse';

    /**
     * Nomor ayat tersebut.
     */
    number: number;

    /**
     * Teks ayat tersebut.
     * Baris-baris puisi dan jeda baris dipisahkan oleh karakter baris baru (\n).
     */
    text: string;

    /**
     * Catatan kaki yang terdapat dalam ayat tersebut.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Judul-judul yang muncul di tengah ayat.
     * Dihilangkan jika ayat tersebut tidak mengandung judul sebaris.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Rentang bagian teks ayat yang mewakili Firman Yesus.
     * Dihilangkan jika ayat tersebut tidak memuatnya.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Rentang teks syair yang mewakili baris-baris puisi.
     * Dihilangkan jika ayat tersebut tidak memuatnya.
     */
    poem?: SimplePoemRange[];
}

/**
 * Subjudul Ibrani dalam sebuah bab.
 * Hal ini seringkali disertakan sebagai konten informatif yang muncul dalam manuskrip asli.
 * Sebagai contoh, Mazmur 49 memiliki subjudul Ibrani "Kepada pemimpin paduan suara. Mazmur dari keturunan Korah."
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Menunjukkan bahwa konten tersebut merupakan Subjudul Ibrani.
     */
    type: 'hebrew_subtitle';
}

/**
 * Catatan kaki dalam sebuah bait.
 */
interface SimpleVerseFootnote {
    /**
     * ID dari uang kertas tersebut.
     */
    noteId: number;

    /**
     * Indeks dalam teks ayat tempat catatan kaki harus disisipkan.
     */
    offset: number;

    /**
     * Teks catatan kaki.
     */
    text: string;

    /**
     * Penelepon yang harus digunakan untuk catatan kaki.
     * Jika "+", maka pemanggil harus dibuat secara otomatis.
     * Jika null, maka pemanggil harus kosong.
     * Jika berupa string, maka pemanggilnya harus berupa string tersebut.
     */
    caller: '+' | string | null;
}

/**
 * Judul yang disisipkan di dalam sebuah ayat.
 */
interface SimpleInlineHeading {
    /**
     * Indeks dalam teks ayat tempat judul tersebut muncul.
     */
    offset: number;

    /**
     * Teks judul.
     */
    text: string;
}

/**
 * Rentang teks di dalam sebuah ayat.
 */
interface SimpleTextRange {
    /**
     * Indeks karakter pertama dari rentang tersebut.
     */
    start: number;

    /**
     * Indeks setelah karakter terakhir dari rentang tersebut.
     */
    end: number;
}

/**
 * Sejumlah teks di dalam sebuah bait yang mewakili satu baris puisi.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Tingkat indentasi yang seharusnya digunakan untuk menampilkan baris puisi.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * ID terjemahan.
     */
    translationId: string;

    /**
     * ID buku tersebut.
     */
    bookId: string;

    /**
     * Nomor bab.
     */
    chapterNumber: number;

    /**
     * Berikut tautan ke bab yang disederhanakan yang menjadi acuan anotasi ini.
     */
    thisChapterLink: string;

    /**
     * Tautan ke bab selanjutnya yang disederhanakan.
     * Bernilai null jika ini adalah bab terakhir dalam terjemahan.
     */
    nextChapterLink: string | null;

    /**
     * Tautan ke bab sebelumnya yang telah disederhanakan.
     * Bernilai null jika ini adalah bab pertama dalam terjemahan.
     */
    previousChapterLink: string | null;

    /**
     * Tautan ke anotasi ini.
     */
    thisChapterWordsLink: string;

    /**
     * Berikut tautan ke anotasi untuk bab berikutnya.
     * Bernilai null jika ini adalah bab terakhir dalam terjemahan, atau jika bab berikutnya tidak memiliki anotasi tingkat kata.
     */
    nextChapterWordsLink: string | null;

    /**
     * Tautan ke anotasi untuk bab sebelumnya.
     * Bernilai null jika ini adalah bab pertama dalam terjemahan, atau jika bab sebelumnya tidak memiliki anotasi tingkat kata.
     */
    previousChapterWordsLink: string | null;

    /**
     * Kata-kata yang diberi keterangan untuk setiap ayat dalam bab tersebut, diurutkan berdasarkan nomor ayat.
     * Setiap daftar disusun sesuai urutan kemunculan kata-kata dalam ayat tersebut.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Anotasi tingkat kata dalam bab yang disederhanakan.
 */
export interface SimpleChapterWord {
    /**
     * Indeks karakter pertama dari kata yang diberi anotasi dalam teks ayat.
     */
    start: number;

    /**
     * Indeks setelah karakter terakhir dari kata yang diberi anotasi dalam teks ayat.
     */
    end: number;

    /**
     * Nomor Strong untuk kata tersebut.
     */
    strongs?: string[];

    /**
     * Lemma (bentuk kamus) dari kata tersebut dalam bahasa sumber.
     */
    lemma?: string;

    /**
     * Morfologi kata dalam bahasa sumber.
     */
    morph?: string;

    /**
     * Lokasi kata tersebut dalam teks sumber.
     */
    srcloc?: string;

    /**
     * Kemunculan kata yang mana dalam ayat ini?
     */
    occurrence?: number;

    /**
     * Jumlah kemunculan kata tersebut dalam ayat.
     */
    occurrences?: number;
}

/**
 * Menentukan data unduhan terjemahan lengkap, menggunakan format bab yang disederhanakan.
 * Dipetakan ke endpoint /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * Metadata terjemahan.
     */
    translation: Translation;

    /**
     * Daftar lengkap buku beserta semua babnya.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Unduh buku terjemahan lengkap, menggunakan format bab yang disederhanakan.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * Daftar lengkap bab beserta seluruh isinya.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Sebuah bab dalam unduhan terjemahan lengkap, menggunakan format bab yang disederhanakan.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * Jumlah ayat yang terdapat dalam bab tersebut.
     */
    numberOfVerses: number;

    /**
     * Berikut tautan ke berbagai versi audio untuk bab ini.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Waktu mulai audio (per ayat, dalam detik) untuk bab tersebut.
     *
     * Perlu dicatat bahwa file terjemahan lengkap berisi pengaturan waktu itu sendiri (lihat TranslationBookChapterAudioTimingsMap di dokumen format standar), tidak seperti titik akhir bab individual yang berisi tautan ke pengaturan waktu tersebut.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Tautan ke anotasi tingkat kata untuk bab tersebut, menggunakan format yang disederhanakan. Dihilangkan jika bab tersebut tidak memiliki anotasi tingkat kata.
     */
    thisChapterWordsLink?: string;

    /**
     * Informasi yang disederhanakan untuk bab ini.
     */
    chapter: SimpleChapterData;
}