Muundo Uliorahisishwa

export interface SimpleTranslationBookChapter {
    /**
     * Taarifa za tafsiri ya sura ya kitabu.
     */
    translation: Translation;

    /**
     * Taarifa za kitabu kwa ajili ya sura ya kitabu.
     */
    book: TranslationBook;

    /**
     * Kiungo cha sura ya sasa.
     */
    thisChapterLink: string;

    /**
     * Kiungo cha toleo la kawaida (lisilorahisishwa) la sura hii.
     */
    fullChapterApiLink: string;

    /**
     * Viungo vya matoleo tofauti ya sauti kwa sura hiyo.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Viungo vya muda wa sauti kwa matoleo tofauti ya sauti kwa sura hiyo.
     * Tazama "Pata Muda wa Sauti kwa Sura" katika hati za umbizo la kawaida - faili ya muda ni sawa bila kujali ni umbizo gani la sura lililounganishwa nalo.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * Kiungo cha sura inayofuata, katika muundo rahisi.
     * Bati ikiwa hii ndiyo sura ya mwisho katika tafsiri.
     */
    nextChapterApiLink: string | null;

    /**
     * Viungo vya matoleo tofauti ya sauti kwa sura inayofuata.
     * Bati ikiwa hii ndiyo sura ya mwisho katika tafsiri.
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Viungo vya muda wa sauti kwa matoleo tofauti ya sauti kwa sura inayofuata.
     * Bati ikiwa hii ndiyo sura ya mwisho katika tafsiri.
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Kiungo cha sura iliyotangulia, katika muundo rahisi.
     * Bati ikiwa hii ndiyo sura ya kwanza katika tafsiri.
     */
    previousChapterApiLink: string | null;

    /**
     * Viungo vya matoleo tofauti ya sauti kwa sura iliyotangulia.
     * Bati ikiwa hii ndiyo sura ya kwanza katika tafsiri.
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * Viungo vya muda wa sauti kwa matoleo tofauti ya sauti kwa sura iliyopita.
     * Bati ikiwa hii ndiyo sura ya kwanza katika tafsiri.
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * Idadi ya mistari ambayo sura hiyo ina.
     */
    numberOfVerses: number;

    /**
     * Taarifa kwa ajili ya sura.
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * Idadi ya sura.
     */
    number: number;

    /**
     * Maudhui ya sura hiyo.
     */
    content: SimpleChapterContent[];

    /**
     * Orodha ya tanbihi ambazo haziwezi kuhusishwa na mstari.
     * Tanbihi za chini zinazohusu mstari zimejumuishwa kwenye mstari wenyewe, kwa hivyo orodha hii kwa kawaida huwa tupu.
     */
    footnotes: ChapterFootnote[];
}

/**
 * Aina ya muungano inayowakilisha kipande kimoja cha maudhui katika sura iliyorahisishwa.
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * Kichwa cha habari katika sura.
 */
interface SimpleChapterHeading {
    /**
     * Inaonyesha kwamba maudhui yanawakilisha kichwa cha habari.
     */
    type: 'heading';

    /**
     * Maandishi ya kichwa cha habari.
     */
    text: string;
}

/**
 * Mgawanyiko wa mstari katika sura.
 */
interface ChapterLineBreak {
    /**
     * Inaonyesha kwamba maudhui yanawakilisha mgawanyiko wa mstari.
     */
    type: 'line_break';
}

/**
 * Mstari katika sura.
 */
interface SimpleChapterVerse {
    /**
     * Inaonyesha kwamba maudhui ni mstari.
     */
    type: 'verse';

    /**
     * Nambari ya mstari.
     */
    number: number;

    /**
     * Maandishi ya mstari huo.
     * Mistari ya ushairi na migawanyiko ya mistari hutenganishwa na herufi mpya (\n).
     */
    text: string;

    /**
     * Tanbihi zinazopatikana katika mstari huo.
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * Vichwa vya habari vinavyotokea katikati ya mstari.
     * Imeachwa ikiwa mstari hauna vichwa vya habari vilivyoandikwa kwa mstari.
     */
    headings?: SimpleInlineHeading[];

    /**
     * Safu za maandishi ya mistari zinazowakilisha Maneno ya Yesu.
     * Imeachwa ikiwa mstari hauna chochote.
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * Safu za maandishi ya mistari zinazowakilisha mistari ya ushairi.
     * Imeachwa ikiwa mstari hauna chochote.
     */
    poem?: SimplePoemRange[];
}

/**
 * Kichwa kidogo cha Kiebrania katika sura.
 * Hizi mara nyingi hujumuishwa kama maudhui ya taarifa yaliyoonekana katika hati asilia.
 * Kwa mfano, Zaburi 49 ina Kichwa Kidogo cha Kiebrania "Kwa kiongozi wa kwaya. Zaburi ya Wana wa Kora."
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * Inaonyesha kwamba maudhui yanawakilisha Kichwa Kidogo cha Kiebrania.
     */
    type: 'hebrew_subtitle';
}

/**
 * Tanbihi katika mstari.
 */
interface SimpleVerseFootnote {
    /**
     * Kitambulisho cha noti.
     */
    noteId: number;

    /**
     * Faharasa katika maandishi ya mstari ambayo mtoa taarifa tanbihi anapaswa kuingizwa.
     */
    offset: number;

    /**
     * Maandishi ya tanbihi.
     */
    text: string;

    /**
     * Mpigaji simu anayepaswa kutumika kwa maelezo ya chini.
     * Ikiwa "+", basi mpigaji simu anapaswa kuzalishwa kiotomatiki.
     * Ikiwa ni batili, basi mpigaji simu anapaswa kuwa mtupu.
     * Ikiwa ni kamba, basi mpigaji anapaswa kuwa kamba hiyo.
     */
    caller: '+' | string | null;
}

/**
 * Kichwa cha habari kilichowekwa ndani ya mstari.
 */
interface SimpleInlineHeading {
    /**
     * Faharasa katika maandishi ya mstari ambapo kichwa cha habari kinatokea.
     */
    offset: number;

    /**
     * Maandishi ya kichwa cha habari.
     */
    text: string;
}

/**
 * Aina mbalimbali za maandishi ndani ya mstari.
 */
interface SimpleTextRange {
    /**
     * Kielezo cha herufi ya kwanza ya masafa.
     */
    start: number;

    /**
     * Faharasa baada ya herufi ya mwisho ya masafa.
     */
    end: number;
}

/**
 * Aina mbalimbali za maandishi ndani ya mstari unaowakilisha mstari wa ushairi.
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * Kiwango cha utangulizi ambacho mstari wa ushairi unapaswa kuonyeshwa nacho.
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * Kitambulisho cha tafsiri.
     */
    translationId: string;

    /**
     * Kitambulisho cha kitabu.
     */
    bookId: string;

    /**
     * Idadi ya sura.
     */
    chapterNumber: number;

    /**
     * Kiungo cha sura iliyorahisishwa ambacho maelezo haya yanalenga.
     */
    thisChapterLink: string;

    /**
     * Kiungo cha sura inayofuata iliyorahisishwa.
     * Bati ikiwa hii ndiyo sura ya mwisho katika tafsiri.
     */
    nextChapterLink: string | null;

    /**
     * Kiungo cha sura iliyorahisishwa iliyotangulia.
     * Bati ikiwa hii ndiyo sura ya kwanza katika tafsiri.
     */
    previousChapterLink: string | null;

    /**
     * Kiungo cha maelezo haya.
     */
    thisChapterWordsLink: string;

    /**
     * Kiungo cha maelezo ya sura inayofuata.
     * Batilisha ikiwa hii ndiyo sura ya mwisho katika tafsiri, au ikiwa sura inayofuata haina maelezo yoyote ya kiwango cha neno.
     */
    nextChapterWordsLink: string | null;

    /**
     * Kiungo cha maelezo ya sura iliyopita.
     * Batilisha ikiwa hii ni sura ya kwanza katika tafsiri, au ikiwa sura iliyotangulia haina maelezo yoyote ya kiwango cha neno.
     */
    previousChapterWordsLink: string | null;

    /**
     * Maneno yaliyoandikwa kwa kila mstari katika sura, yameunganishwa na nambari ya mstari.
     * Kila orodha iko katika mpangilio ambao maneno yanatokea katika mstari.
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * Maelezo ya kiwango cha neno katika sura iliyorahisishwa.
 */
export interface SimpleChapterWord {
    /**
     * Faharasa ya herufi ya kwanza ya neno lililoandikwa kwa ufasaha katika maandishi ya mstari.
     */
    start: number;

    /**
     * Faharasa baada ya herufi ya mwisho ya neno lililofafanuliwa katika maandishi ya mstari.
     */
    end: number;

    /**
     * Nambari za Strong kwa neno.
     */
    strongs?: string[];

    /**
     * Lemma (umbo la kamusi) la neno katika lugha chanzi.
     */
    lemma?: string;

    /**
     * Mofolojia ya neno katika lugha chanzi.
     */
    morph?: string;

    /**
     * Mahali pa neno katika maandishi chanzo.
     */
    srcloc?: string;

    /**
     * Ni neno gani linalojitokeza katika mstari huu?
     */
    occurrence?: number;

    /**
     * Idadi ya mara ambazo neno hilo linatokea katika mstari.
     */
    occurrences?: number;
}

/**
 * Hufafanua data kamili ya upakuaji wa tafsiri, kwa kutumia umbizo la sura lililorahisishwa.
 * Ramani za sehemu ya mwisho ya /api/:translationId/complete.simple.json.
 */
export interface SimpleTranslationComplete {
    /**
     * Metadata ya tafsiri.
     */
    translation: Translation;

    /**
     * Orodha kamili ya vitabu vyenye sura zao zote.
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * Kitabu katika tafsiri kamili ya kupakua, kwa kutumia umbizo rahisi la sura.
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * Orodha kamili ya sura zenye maudhui yote.
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * Sura katika tafsiri kamili ya kupakua, kwa kutumia umbizo la sura lililorahisishwa.
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * Idadi ya mistari ambayo sura hiyo ina.
     */
    numberOfVerses: number;

    /**
     * Viungo vya matoleo tofauti ya sauti kwa sura hiyo.
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * Muda wa sauti (wakati wa kuanza kwa kila mstari, kwa sekunde) kwa sura.
     *
     * Kumbuka kwamba faili kamili za tafsiri zina muda wenyewe (tazama TranslationBookChapterAudioTimingsMap katika hati za umbizo la kawaida), tofauti na sehemu za mwisho za sura, ambazo zina viungo vyake.
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * Kiungo cha maelezo ya kiwango cha neno kwa sura, kwa kutumia umbizo lililorahisishwa. Haijatolewa ikiwa sura haina maelezo yoyote ya kiwango cha neno.
     */
    thisChapterWordsLink?: string;

    /**
     * Taarifa iliyorahisishwa kwa sura hiyo.
     */
    chapter: SimpleChapterData;
}