Tsarin Daidaitacce

export interface TranslationBookChapter {
    /**
     * Bayanin fassarar babin littafin.
     */
    translation: Translation;

    /**
     * Bayanin littafin don babin littafin.
     */
    book: TranslationBook;

    /**
     * Haɗin zuwa babi na yanzu.
     */
    thisChapterLink: string;

    /**
     * Hanyoyin haɗi zuwa nau'ikan sauti daban-daban don babin.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Hanyoyin haɗi zuwa lokutan sauti don nau'ikan sauti daban-daban na babin.
     * Kowace hanyar haɗi tana nuna fayil ɗin lokacin sauti na wannan mai karatu - duba "Sami Lokutan Sauti don Babi" a ƙasa.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Hanyar haɗi zuwa babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterApiLink: string | null;

    /**
     * Hanyoyin haɗi zuwa nau'ikan sauti daban-daban don babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Hanyoyin haɗi zuwa lokutan sauti don nau'ikan sauti daban-daban don babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Hanyar haɗi zuwa babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterApiLink: string | null;

    /**
     * Hanyoyin haɗi zuwa nau'ikan sauti daban-daban na babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Hanyoyin haɗi zuwa lokutan sauti don nau'ikan sauti daban-daban na babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Hanyar haɗi zuwa bayanin matakin kalma don babin.
     * Ba a cire shi ba idan babin ba shi da wani bayani na matakin kalma.
     */
    thisChapterWordsLink?: string;

    /**
     * Hanyar haɗi zuwa bayanin kalmomi don babi na gaba.
     * An yi watsi da shi idan wannan shine babi na ƙarshe a fassarar, ko kuma idan babi na gaba ba shi da wani bayani na matakin kalma.
     */
    nextChapterWordsLink?: string;

    /**
     * Hanyar haɗi zuwa bayanin kalmomi na babi na baya.
     * An yi watsi da shi idan wannan shine babi na farko a cikin fassarar, ko kuma idan babi na baya ba shi da wani bayani na matakin kalma.
     */
    previousChapterWordsLink?: string;

    /**
     * Adadin ayoyin da surar ta kunsa.
     */
    numberOfVerses: number;

    /**
     * Hanyar haɗi zuwa sigar da aka sauƙaƙa ta wannan babi.
     * An yi watsi da shi idan ba a samu sassauƙan surori ba.
     */
    simpleChapterApiLink?: string;

    /**
     * Bayanin da aka bayar don babi.
     */
    chapter: ChapterData;
}

interface ChapterData {
    /**
     * Adadin babin.
     */
    number: number;

    /**
     * Abubuwan da ke cikin babin.
     */
    content: ChapterContent[];

    /**
     * Jerin bayanan ƙasa na babin.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Nau'in ƙungiyar da ke wakiltar wani ɓangare ɗaya na abubuwan da ke cikin babi.
 * Rubutun wani ɓangare na babi zai iya zama ɗaya daga cikin waɗannan abubuwa:
 * - Kanun labarai.
 * - Rage layi.
 * - Aya.
 * - Subtitle na Ibrananci.
 */
type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

/**
 * Kan magana a cikin wani babi.
 */
interface ChapterHeading {
    /**
     * Yana nuna cewa abubuwan da ke ciki suna wakiltar wani taken.
     */
    type: 'heading';

    /**
     * Abubuwan da ke cikin taken.
     * Idan an haɗa igiyoyi da yawa a cikin jerin, ya kamata a haɗa su da sarari.
     */
    content: string[];
}

/**
 * Rage layi a cikin babi.
 */
interface ChapterLineBreak {
    /**
     * Yana nuna cewa abubuwan da ke ciki suna wakiltar karya layi.
     */
    type: 'line_break';
}

/**
 * Subtitle na Ibrananci a cikin babi.
 * Ana amfani da waɗannan sau da yawa azaman abubuwan da ke cikin bayanai waɗanda suka bayyana a cikin rubutun asali.
 * Misali, Zabura ta 49 tana da taken Ibrananci "Ga shugaban mawaƙa. Zabura ta 'Ya'yan Kora."
 */
interface ChapterHebrewSubtitle {
    /**
     * Yana nuna cewa abubuwan da ke ciki suna wakiltar Subtitle na Ibrananci.
     */
    type: 'hebrew_subtitle';

    /**
     * Jerin abubuwan da ke cikin ƙaramin taken.
     * Kowace abu a cikin jerin na iya zama igiya, rubutu da aka tsara, ko kuma bayanin ƙasa.
     */
    content: (string | FormattedText | VerseFootnoteReference)[];
}

/**
 * Aya a cikin babi.
 */
interface ChapterVerse {
    /**
     * Yana nuna cewa abin da ke ciki aya ce.
     */
    type: 'verse';

    /**
     * Adadin ayar.
     */
    number: number;

    /**
     * Jerin abubuwan da ke cikin ayar.
     * Kowace abu a cikin jerin na iya zama igiya, rubutu da aka tsara, ko kuma bayanin ƙasa.
     */
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

/**
 * Rubutun da aka tsara. Wato, rubutun da aka tsara ta wata hanya ta musamman.
 */
interface FormattedText {
    /**
     * Rubutun da aka tsara.
     */
    text: string;

    /**
     * Ko rubutun yana wakiltar waƙa.
     * Lambar tana nuna matakin ƙofa.
     *
     * Wanda aka saba gani a cikin Zabura.
     */
    poem?: number;

    /**
     * Ko rubutun yana wakiltar Kalmomin Yesu.
     */
    wordsOfJesus?: boolean;
}

/**
 * Yana bayyana hanyar sadarwa da ke wakiltar wani jigo da aka saka a cikin aya.
 */
interface InlineHeading {
    /**
     * Rubutun kanun.
     */
    heading: string;
}

/**
 * Yana bayyana hanyar sadarwa da ke wakiltar wani layin da aka saka a cikin aya.
 */
interface InlineLineBreak {
    lineBreak: true;
}


/**
 * Nassin bayan shafi a cikin aya ko kuma Subtitle na Ibrananci.
 */
interface VerseFootnoteReference {
    /**
     * ID na takardar.
     */
    noteId: number;
}

/**
 * Bayani game da alamar ƙasa.
 */
interface ChapterFootnote {
    /**
     * ID na takardar da aka ambata.
     */
    noteId: number;

    /**
     * Rubutun ƙasan ƙasa.
     */
    text: string;

    /**
     * Nassin ayar don bayanin ƙasa.
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * Mai kiran da ya kamata a yi amfani da shi don yin amfani da ƙasidar ƙasa.
     * Ga ƙasidar ƙasa, "mai kira" shine harafin da ake amfani da shi a cikin rubutun don yin nuni ga ƙasidar ƙasa.
     *
     * Misali, a cikin rubutun:
     * Sannu (a) Duniya
     *
     * ---- (a) Wannan bayanin ƙasa ne.
     *
     * "(a)" shine mai kiran.
     *
     * Idan "+" ne, to ya kamata a ƙirƙiri mai kiran ta atomatik.
     * Idan babu komai, to mai kiran ya kamata ya zama babu komai.
     * Idan igiya ce, to mai kiran ya kamata ya zama igiyar.
     */
    caller: '+' | string | null;
}

/**
 * Hanyoyin sauti don babi na littafi.
 */
interface TranslationBookChapterAudioLinks {
    /**
     * Mai karatu na babi da kuma hanyar haɗin URL zuwa fayil ɗin sauti.
     */
    [reader: string]: string;
}

/**
 * Hanyoyin sauti na babi na littafi suna da alaƙa da lokacin da za a ɗauka.
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * Mai karatu na babi da kuma hanyar haɗin API zuwa fayil ɗin lokutan sauti na wannan mai karatu.
     */
    [reader: string]: string;
}

/**
 * Yana bayyana lokutan sauti na babi na littafi, ga mai karatu ɗaya.
 * Taswirori zuwa ƙarshen /api/{translation}/{book}/{babi}.{reader}.audioTimings.json.
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * ID na fassarar.
     */
    translationId: string;

    /**
     * ID na littafin.
     */
    bookId: string;

    /**
     * Adadin babin.
     */
    chapterNumber: number;

    /**
     * ID na mai karatu wanda waɗannan lokutan suke yi.
     */
    reader: string;

    /**
     * Hanyar haɗi zuwa fayil ɗin sauti da waɗannan lokutan suke.
     */
    audioLink: string;

    /**
     * Hanyar haɗi zuwa bayanin wannan babi.
     */
    thisChapterLink: string;

    /**
     * Hanyar haɗi zuwa bayanin don babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterLink: string | null;

    /**
     * Hanyar haɗi zuwa bayanin da ke cikin babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterLink: string | null;

    /**
     * Hanyar haɗi zuwa wannan fayil ɗin lokacin sauti.
     */
    thisChapterAudioTimingsLink: string;

    /**
     * Hanyar haɗi zuwa lokutan babi na gaba, ga mai karatu ɗaya.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterAudioTimingsLink: string | null;

    /**
     * Hanyar haɗi zuwa lokutan babi na baya, ga mai karatu ɗaya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterAudioTimingsLink: string | null;

    /**
     * Lokutan da kowace aya ta fara a cikin daƙiƙa, cikin tsari.
     * Lamba ta farko (fihiri 0) ita ce lokacin da ayar farko ta fara a cikin rikodin.
     */
    verses: number[];
}

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

    /**
     * ID na littafin.
     */
    bookId: string;

    /**
     * Adadin babin.
     */
    chapterNumber: number;

    /**
     * Hanyar haɗi zuwa bayanin wannan babi.
     */
    thisChapterLink: string;

    /**
     * Hanyar haɗi zuwa bayanin don babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar.
     */
    nextChapterLink: string | null;

    /**
     * Hanyar haɗi zuwa bayanin da ke cikin babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar.
     */
    previousChapterLink: string | null;

    /**
     * Hanyar haɗi zuwa wannan fayil ɗin kalmomi.
     */
    thisChapterWordsLink: string;

    /**
     * Hanyar haɗi zuwa kalmomin don babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a fassarar, ko kuma idan babi na gaba ba shi da wani bayani na matakin kalma.
     */
    nextChapterWordsLink: string | null;

    /**
     * Hanyar haɗi zuwa kalmomin babi na baya.
     * Babu komai idan wannan shine babi na farko a fassarar, ko kuma idan babi na baya ba shi da wani bayani na matakin kalma.
     */
    previousChapterWordsLink: string | null;

    /**
     * Kalmomin da aka rubuta a cikin kowace aya a cikin surar, waɗanda aka manne da lambar aya.
     * Kowanne jeri yana cikin tsarin da kalmomin suka bayyana a cikin ayar.
     */
    verses: {
        [verseNumber: string]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * Fihirisar abin da ke cikin jerin abubuwan da ke cikin ayar da bayanin ya shafi.
     */
    contentIndex: number;

    /**
     * Fihirisar harafin farko na kalmar da aka yi wa alama a cikin rubutun abun ciki.
     */
    start: number;

    /**
     * Fihirisar da ke bayan harafin ƙarshe na kalmar da aka yi wa alama a cikin rubutun abin da ke ciki.
     * Wato, text.slice(farko, ƙarshe) ita ce kalmar da aka yi bayani a kai.
     */
    end: number;

    /**
     * Lambar(s) na kalmar The Strong.
     * An yi watsi da fassarar idan fassarar ta ba da wasu bayanai kawai ga kalmar.
     */
    strongs?: string[];

    /**
     * Siffar ƙamus (ƙirƙirar) kalmar.
     * An yi watsi da fassarar idan fassarar ba ta bayar da ɗaya ba.
     */
    lemma?: string;

    /**
     * Lambar nazarin yanayin kalma.
     * An yi watsi da fassarar idan fassarar ba ta bayar da ɗaya ba.
     */
    morph?: string;

    /**
     * Mai nuna kalmar a cikin rubutun tushe, a cikin tsarin <sourceName> : <location> .
     * An yi watsi da fassarar idan fassarar ba ta bayar da ɗaya ba.
     */
    srcloc?: string;

    /**
     * Wace irin asalin kalmar da wannan kalmar ta samo asali. 1-tushen.
     * An yi watsi da fassarar idan fassarar ba ta bayar da ɗaya ba.
     */
    occurrence?: number;

    /**
     * Jimillar adadin lokutan da kalmar tushe ta bayyana.
     * An yi watsi da fassarar idan fassarar ba ta bayar da ɗaya ba.
     */
    occurrences?: number;
}

/**
 * Yana bayyana cikakken bayanan sauke fassarar.
 * Taswirori zuwa ƙarshen /api/:translationId/complete.json.
 */
export interface TranslationComplete {
    /**
     * Bayanan fassarar.
     */
    translation: Translation;

    /**
     * Cikakken jerin littattafai tare da dukkan surori.
     */
    books: TranslationCompleteBook[];
}

/**
 * Littafi a cikin cikakken fassarar da aka sauke.
 */
export interface TranslationCompleteBook {
    /**
     * ID na littafin.
     */
    id: string;

    /**
     * Sunan littafin daga fassarar.
     */
    name: string;

    /**
     * Sunan da aka saba amfani da shi a littafin.
     */
    commonName: string;

    /**
     * Sunan littafin.
     */
    title: string | null;

    /**
     * Tsarin littafin.
     */
    order: number;

    /**
     * Adadin surori a cikin littafin.
     */
    numberOfChapters: number;

    /**
     * Jimillar ayoyi a cikin littafin.
     */
    totalNumberOfVerses: number;

    /**
     * Ko littafin apokrifa ne.
     */
    isApocryphal?: boolean;

    /**
     * Cikakken jerin surori tare da duk abubuwan da ke ciki.
     */
    chapters: TranslationCompleteChapter[];
}

/**
 * Babi a cikin cikakken fassarar da aka sauke.
 */
export interface TranslationCompleteChapter {
    /**
     * Adadin ayoyin da surar ta kunsa.
     */
    numberOfVerses: number;

    /**
     * Hanyoyin haɗi zuwa nau'ikan sauti daban-daban don babin.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Lokacin sauti (kowace aya lokacin farawa, a cikin daƙiƙa) don nau'ikan sauti daban-daban na babin.
     *
     * Ba kamar `thisChapterAudioTimings` a ƙarshen babin babi ɗaya ba (wanda ke haɗe zuwa "Sami Lokutan Sauti don Babi" a ƙasa), wannan ya ƙunshi lokutan da kansu - tunda manufar sauke fassarar gaba ɗaya ita ce a sami komai a cikin fayil ɗaya.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Hanyar haɗi zuwa bayanin matakin kalma don babin.
     * Ba a cire shi ba idan babin ba shi da wani bayani na matakin kalma.
     */
    thisChapterWordsLink?: string;

    /**
     * Bayanin da aka bayar don babi.
     */
    chapter: ChapterData;
}

/**
 * Lokacin sauti na babi na littafi, an saka shi kai tsaye maimakon a haɗa shi.
 * Yana nuna katin shaidar mai karatu zuwa jerin lokutan da kowace aya ta fara (a cikin daƙiƙa), bisa ga tsarin baiti.
 */
interface TranslationBookChapterAudioTimingsMap {
    [reader: string]: number[];
}