Format Standar

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

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

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

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

    /**
     * Berikut tautan ke pengaturan waktu audio untuk berbagai versi audio bab ini.
     * Setiap tautan mengarah ke file pengaturan waktu audio untuk pembaca tersebut - lihat "Dapatkan Pengaturan Waktu Audio untuk Sebuah Bab" di bawah.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Tautan ke bab selanjutnya.
     * 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.
     * 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;

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

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

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

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

    /**
     * Berikut tautan ke versi ringkas bab ini.
     * Dihilangkan jika bab yang disederhanakan tidak tersedia.
     */
    simpleChapterApiLink?: string;

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

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

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

    /**
     * Daftar catatan kaki untuk bab tersebut.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Tipe gabungan yang mewakili satu bagian konten bab.
 * Salah satu isi bab dapat berupa hal-hal berikut:
 * - Sebuah judul.
 * - Pemutusan baris.
 * - Sebuah ayat.
 * - Subjudul Bahasa Ibrani.
 */
type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

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

    /**
     * Isi untuk judul.
     * Jika terdapat beberapa string dalam array, string tersebut harus digabungkan dengan spasi.
     */
    content: string[];
}

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

/**
 * Subjudul Ibrani dalam sebuah bab.
 * Ini sering digunakan sebagai konten informatif yang muncul dalam manuskrip asli.
 * Sebagai contoh, Mazmur 49 memiliki subjudul Ibrani "Kepada pemimpin paduan suara. Mazmur dari keturunan Korah."
 */
interface ChapterHebrewSubtitle {
    /**
     * Menunjukkan bahwa konten tersebut merupakan Subjudul Ibrani.
     */
    type: 'hebrew_subtitle';

    /**
     * Daftar isi yang terdapat dalam subjudul.
     * Setiap elemen dalam daftar dapat berupa string, teks yang diformat, atau referensi catatan kaki.
     */
    content: (string | FormattedText | VerseFootnoteReference)[];
}

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

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

    /**
     * Daftar isi ayat tersebut.
     * Setiap elemen dalam daftar dapat berupa string, teks yang diformat, atau referensi catatan kaki.
     */
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

/**
 * Teks yang diformat. Yaitu, teks yang diformat dengan cara tertentu.
 */
interface FormattedText {
    /**
     * Teks yang telah diformat.
     */
    text: string;

    /**
     * Apakah teks tersebut merupakan sebuah puisi.
     * Angka tersebut menunjukkan tingkat indentasi.
     *
     * Umum ditemukan dalam Kitab Mazmur.
     */
    poem?: number;

    /**
     * Apakah teks tersebut mewakili perkataan Yesus.
     */
    wordsOfJesus?: boolean;
}

/**
 * Mendefinisikan antarmuka yang mewakili judul yang tertanam dalam sebuah ayat.
 */
interface InlineHeading {
    /**
     * Teks judul.
     */
    heading: string;
}

/**
 * Mendefinisikan antarmuka yang mewakili jeda baris yang tertanam dalam sebuah ayat.
 */
interface InlineLineBreak {
    lineBreak: true;
}


/**
 * Referensi catatan kaki dalam sebuah ayat atau subjudul Ibrani.
 */
interface VerseFootnoteReference {
    /**
     * ID dari uang kertas tersebut.
     */
    noteId: number;
}

/**
 * Informasi tentang catatan kaki.
 */
interface ChapterFootnote {
    /**
     * ID dari catatan yang dirujuk.
     */
    noteId: number;

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

    /**
     * Referensi ayat untuk catatan kaki.
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * Penelepon yang harus digunakan untuk catatan kaki.
     * Untuk catatan kaki, "penanda" adalah karakter yang digunakan dalam teks untuk merujuk ke catatan kaki.
     *
     * Misalnya, dalam teks:
     * Halo (a) Dunia
     *
     * ---- (a) Ini adalah catatan kaki.
     *
     * "(a)" adalah pemanggil.
     *
     * 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;
}

/**
 * Tautan audio untuk sebuah bab buku.
 */
interface TranslationBookChapterAudioLinks {
    /**
     * Teks bacaan untuk bab tersebut dan tautan URL ke file audio.
     */
    [reader: string]: string;
}

/**
 * Tautan pengaturan waktu audio untuk sebuah bab buku.
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * Informasi pembaca untuk bab tersebut dan tautan API ke file pengaturan waktu audio untuk pembaca tersebut.
     */
    [reader: string]: string;
}

/**
 * Menentukan pengaturan waktu audio untuk satu bab buku, untuk satu pembaca.
 * Dipetakan ke endpoint /api/{translation}/{book}/{chapter}.{reader}.audioTimings.json.
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * ID terjemahan.
     */
    translationId: string;

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

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

    /**
     * ID pembaca yang digunakan untuk pengukuran waktu ini.
     */
    reader: string;

    /**
     * Berikut tautan ke file audio yang berisi pengaturan waktu ini.
     */
    audioLink: string;

    /**
     * Berikut tautan ke informasi untuk bab ini.
     */
    thisChapterLink: string;

    /**
     * Berikut tautan ke informasi untuk bab selanjutnya.
     * Bernilai null jika ini adalah bab terakhir dalam terjemahan.
     */
    nextChapterLink: string | null;

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

    /**
     * Berikut tautan ke file pengaturan waktu audio ini.
     */
    thisChapterAudioTimingsLink: string;

    /**
     * Berikut tautan ke jadwal untuk bab berikutnya, untuk pembaca yang sama.
     * Bernilai null jika ini adalah bab terakhir dalam terjemahan.
     */
    nextChapterAudioTimingsLink: string | null;

    /**
     * Berikut tautan ke jadwal untuk bab sebelumnya, untuk pembaca yang sama.
     * Bernilai null jika ini adalah bab pertama dalam terjemahan.
     */
    previousChapterAudioTimingsLink: string | null;

    /**
     * Waktu dalam detik saat setiap bait dimulai, secara berurutan.
     * Angka pertama (indeks 0) adalah waktu dalam rekaman saat bait pertama dimulai.
     */
    verses: number[];
}

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

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

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

    /**
     * Berikut tautan ke informasi untuk bab ini.
     */
    thisChapterLink: string;

    /**
     * Berikut tautan ke informasi untuk bab selanjutnya.
     * Bernilai null jika ini adalah bab terakhir dalam terjemahan.
     */
    nextChapterLink: string | null;

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

    /**
     * Tautan ke berkas kata-kata ini.
     */
    thisChapterWordsLink: string;

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

    /**
     * Tautan ke kata-kata 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]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * Indeks item dalam larik konten ayat yang berlaku untuk anotasi tersebut.
     */
    contentIndex: number;

    /**
     * Indeks karakter pertama dari kata yang diberi anotasi dalam teks item konten.
     */
    start: number;

    /**
     * Indeks setelah karakter terakhir dari kata yang diberi anotasi dalam teks item konten.
     * Artinya, text.slice(start, end) adalah kata yang diberi anotasi.
     */
    end: number;

    /**
     * Nomor Strong untuk kata tersebut.
     * Dihilangkan jika terjemahan hanya memberikan anotasi lain untuk kata tersebut.
     */
    strongs?: string[];

    /**
     * Bentuk kata dalam kamus (kutipan).
     * Dihilangkan jika terjemahan tidak menyediakannya.
     */
    lemma?: string;

    /**
     * Kode penguraian morfologi untuk kata tersebut.
     * Dihilangkan jika terjemahan tidak menyediakannya.
     */
    morph?: string;

    /**
     * Penunjuk ke kata dalam teks sumber, dalam format <sourceName> : <location> .
     * Dihilangkan jika terjemahan tidak menyediakannya.
     */
    srcloc?: string;

    /**
     * Kemunculan kata sumber yang mana dari kata ini. Berbasis 1.
     * Dihilangkan jika terjemahan tidak menyediakannya.
     */
    occurrence?: number;

    /**
     * Jumlah total kemunculan kata sumber.
     * Dihilangkan jika terjemahan tidak menyediakannya.
     */
    occurrences?: number;
}

/**
 * Menentukan data unduhan terjemahan lengkap.
 * Dipetakan ke endpoint /api/:translationId/complete.json.
 */
export interface TranslationComplete {
    /**
     * Metadata terjemahan.
     */
    translation: Translation;

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

/**
 * Unduh buku terjemahan lengkapnya.
 */
export interface TranslationCompleteBook {
    /**
     * ID buku tersebut.
     */
    id: string;

    /**
     * Judul buku berdasarkan terjemahan.
     */
    name: string;

    /**
     * Nama umum untuk buku tersebut.
     */
    commonName: string;

    /**
     * Judul buku tersebut.
     */
    title: string | null;

    /**
     * Urutan buku tersebut.
     */
    order: number;

    /**
     * Jumlah bab dalam buku tersebut.
     */
    numberOfChapters: number;

    /**
     * Jumlah total ayat dalam buku tersebut.
     */
    totalNumberOfVerses: number;

    /**
     * Apakah buku itu apokrif.
     */
    isApocryphal?: boolean;

    /**
     * Daftar lengkap bab beserta seluruh isinya.
     */
    chapters: TranslationCompleteChapter[];
}

/**
 * Sebuah bab dalam unduhan terjemahan lengkap.
 */
export interface TranslationCompleteChapter {
    /**
     * 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 berbagai versi audio dari bab tersebut.
     *
     * Tidak seperti `thisChapterAudioTimings` pada titik akhir bab individual (yang mengarah ke "Dapatkan Pengaturan Waktu Audio untuk Sebuah Bab" di bawah), ini berisi pengaturan waktu itu sendiri - karena tujuan dari unduhan terjemahan lengkap adalah untuk memiliki semuanya dalam satu file.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

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

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

/**
 * Pengaturan waktu audio untuk sebuah bab buku, disematkan langsung dan bukan berupa tautan.
 * Memetakan ID pembaca ke daftar waktu (dalam detik) dimulainya setiap ayat, sesuai urutan ayat.
 */
interface TranslationBookChapterAudioTimingsMap {
    [reader: string]: number[];
}