ቀለል ያለ ቅርጸት

export interface SimpleTranslationBookChapter {
    /**
     * የመጽሐፉ ምዕራፍ የትርጉም መረጃ።
     */
    translation: Translation;

    /**
     * ለመጽሐፉ ምዕራፍ የመጽሐፉ መረጃ።
     */
    book: TranslationBook;

    /**
     * ወደ የአሁኑ ምዕራፍ የሚወስድ አገናኝ።
     */
    thisChapterLink: string;

    /**
     * የዚህ ምዕራፍ መደበኛ (ቀላል ያልሆነ) ስሪት አገናኝ።
     */
    fullChapterApiLink: string;

    /**
     * ለምዕራፉ የተለያዩ የድምጽ ስሪቶች አገናኞች።
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * ለምዕራፉ የተለያዩ የድምጽ ስሪቶች የድምጽ ጊዜዎች አገናኞች።
     * በመደበኛው የሰነዶች ቅርጸት "ለአንድ ምዕራፍ የድምጽ ጊዜዎችን ያግኙ" የሚለውን ይመልከቱ - የጊዜ ፋይሉ ከየትኛውም የምዕራፍ ቅርጸት ጋር ቢገናኝም ተመሳሳይ ነው።
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

    /**
     * ወደሚቀጥለው ምዕራፍ የሚወስደው አገናኝ፣ በቀላል ቅርጸት።
     * ይህ የትርጉም የመጨረሻው ምዕራፍ ከሆነ ባዶ ነው።
     */
    nextChapterApiLink: string | null;

    /**
     * ለቀጣዩ ምዕራፍ ወደተለያዩ የድምጽ ቅጂዎች የሚወስዱ አገናኞች።
     * ይህ የትርጉም የመጨረሻው ምዕራፍ ከሆነ ባዶ ነው።
     */
    nextChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * ለቀጣዩ ምዕራፍ የተለያዩ የድምጽ ስሪቶች የድምጽ ጊዜዎች አገናኞች።
     * ይህ የትርጉም የመጨረሻው ምዕራፍ ከሆነ ባዶ ነው።
     */
    nextChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * ወደ ቀዳሚው ምዕራፍ የሚወስደው አገናኝ፣ በቀላል ቅርጸት።
     * ይህ በትርጉሙ ውስጥ የመጀመሪያው ምዕራፍ ከሆነ ባዶ ነው።
     */
    previousChapterApiLink: string | null;

    /**
     * ለቀደመው ምዕራፍ ወደተለያዩ የድምጽ ስሪቶች የሚወስዱ አገናኞች።
     * ይህ በትርጉሙ ውስጥ የመጀመሪያው ምዕራፍ ከሆነ ባዶ ነው።
     */
    previousChapterAudioLinks: TranslationBookChapterAudioLinks | null;

    /**
     * ለቀደመው ምዕራፍ የተለያዩ የድምጽ ስሪቶች የድምጽ ጊዜ አገናኞች።
     * ይህ በትርጉሙ ውስጥ የመጀመሪያው ምዕራፍ ከሆነ ባዶ ነው።
     */
    previousChapterAudioTimings: TranslationBookChapterAudioTimingsLinks | null;

    /**
     * ምዕራፉ የያዘው የቁጥሮች ብዛት።
     */
    numberOfVerses: number;

    /**
     * ለምዕራፉ የተሰጠው መረጃ።
     */
    chapter: SimpleChapterData;
}

interface SimpleChapterData {
    /**
     * የምዕራፉ ቁጥር።
     */
    number: number;

    /**
     * የምዕራፉ ይዘት።
     */
    content: SimpleChapterContent[];

    /**
     * ከጥቅስ ጋር ሊዛመዱ የማይችሉ የግርጌ ማስታወሻዎች ዝርዝር።
     * የአንድ ጥቅስ የግርጌ ማስታወሻዎች በጥቅሱ ራሱ ላይ ተካትተዋል፣ ስለዚህ ይህ ዝርዝር ብዙውን ጊዜ ባዶ ነው።
     */
    footnotes: ChapterFootnote[];
}

/**
 * በቀላል ምዕራፍ ውስጥ አንድ የይዘት ክፍልን የሚወክል የህብረት አይነት።
 */
type SimpleChapterContent = SimpleChapterHeading | ChapterLineBreak | SimpleChapterVerse | SimpleChapterHebrewSubtitle;

/**
 * በአንድ ምዕራፍ ውስጥ ያለ ርዕስ።
 */
interface SimpleChapterHeading {
    /**
     * ይዘቱ ርዕስን እንደሚወክል ያመለክታል።
     */
    type: 'heading';

    /**
     * የርዕሱ ጽሑፍ።
     */
    text: string;
}

/**
 * በአንድ ምዕራፍ ውስጥ የመስመር መግቻ።
 */
interface ChapterLineBreak {
    /**
     * ይዘቱ የመስመር መግቻን እንደሚወክል ያመለክታል።
     */
    type: 'line_break';
}

/**
 * በአንድ ምዕራፍ ውስጥ ያለ ጥቅስ።
 */
interface SimpleChapterVerse {
    /**
     * ይዘቱ አንድ ጥቅስ መሆኑን ያመለክታል።
     */
    type: 'verse';

    /**
     * የጥቅሱ ቁጥር።
     */
    number: number;

    /**
     * የጥቅሱ ጽሑፍ።
     * የግጥም መስመሮች እና የመስመር ክፍተቶች በአዲስ መስመር (\n) ገፀ-ባህሪያት ተለያይተዋል።
     */
    text: string;

    /**
     * በጥቅሱ ውስጥ የሚገኙት የግርጌ ማስታወሻዎች።
     */
    footnotes: SimpleVerseFootnote[];

    /**
     * በጥቅሱ መሃል ላይ የሚከሰቱት ርዕሶች።
     * ጥቅሱ ምንም አይነት የውስጥ ርዕስ ከሌለው ይሰረዛል።
     */
    headings?: SimpleInlineHeading[];

    /**
     * የኢየሱስን ቃላት የሚወክሉ የጥቅሱ ክፍሎች።
     * ጥቅሱ ምንም ነገር ከሌለው ተትቷል።
     */
    wordsOfJesus?: SimpleTextRange[];

    /**
     * የግጥም መስመሮችን የሚወክሉ የግጥም ጽሑፍ ክልሎች።
     * ጥቅሱ ምንም ነገር ከሌለው ተትቷል።
     */
    poem?: SimplePoemRange[];
}

/**
 * በአንድ ምዕራፍ ውስጥ የሚገኝ የዕብራይስጥ ንዑስ ርዕስ።
 * እነዚህ ብዙውን ጊዜ በዋናዎቹ የእጅ ጽሑፎች ውስጥ እንደ መረጃ ሰጪ ይዘት ይካተታሉ።
 * ለምሳሌ፣ መዝሙር 49 የዕብራይስጥ ንዑስ ርዕስ አለው "ለመዘምራን አለቃ። የቆሬ ልጆች መዝሙር።"
 */
interface SimpleChapterHebrewSubtitle extends Omit<SimpleChapterVerse, 'type' | 'number'> {
    /**
     * ይዘቱ የዕብራይስጥ ንዑስ ርዕስን እንደሚወክል ያመለክታል።
     */
    type: 'hebrew_subtitle';
}

/**
 * በአንድ ጥቅስ ውስጥ የግርጌ ማስታወሻ።
 */
interface SimpleVerseFootnote {
    /**
     * የማስታወሻው መታወቂያ።
     */
    noteId: number;

    /**
     * የግርጌ ማስታወሻ ደዋዩ ማስገባት ያለበት በጥቅሱ ጽሑፍ ውስጥ ያለው ማውጫ።
     */
    offset: number;

    /**
     * የግርጌ ማስታወሻው ጽሑፍ።
     */
    text: string;

    /**
     * ለግርጌ ማስታወሻው ጥቅም ላይ መዋል ያለበት ደዋይ።
     * "+" ከሆነ ደዋዩ በራስ-ሰር መፈጠር አለበት።
     * ባዶ ከሆነ ደዋዩ ባዶ መሆን አለበት።
     * ሕብረቁምፊ ከሆነ፣ ደዋዩ ያ ሕብረቁምፊ መሆን አለበት።
     */
    caller: '+' | string | null;
}

/**
 * በአንድ ጥቅስ ውስጥ የተካተተ ርዕስ።
 */
interface SimpleInlineHeading {
    /**
     * ርዕሱ በጥቅሱ ጽሑፍ ውስጥ የሚገኘው ማውጫ።
     */
    offset: number;

    /**
     * የርዕሱ ጽሑፍ።
     */
    text: string;
}

/**
 * በአንድ ጥቅስ ውስጥ የፅሁፍ ክልል።
 */
interface SimpleTextRange {
    /**
     * የክልል የመጀመሪያው ቁምፊ መረጃ ጠቋሚ።
     */
    start: number;

    /**
     * ከክልሉ የመጨረሻ ቁምፊ በኋላ ያለው መረጃ ጠቋሚ።
     */
    end: number;
}

/**
 * የግጥም መስመርን የሚወክል በአንድ ጥቅስ ውስጥ ያለ የጽሑፍ ክልል።
 */
interface SimplePoemRange extends SimpleTextRange {
    /**
     * የግጥም መስመሩ መታየት ያለበት የገባ ደረጃ።
     */
    level: number;
}

export interface SimpleTranslationBookChapterWords {
    /**
     * የትርጉሙ መታወቂያ።
     */
    translationId: string;

    /**
     * የመጽሐፉ መታወቂያ።
     */
    bookId: string;

    /**
     * የምዕራፉ ቁጥር።
     */
    chapterNumber: number;

    /**
     * እነዚህ ማብራሪያዎች የሚቀርቡበት ወደ ቀለል ወዳለው ምዕራፍ የሚወስድ አገናኝ።
     */
    thisChapterLink: string;

    /**
     * ወደሚቀጥለው ቀለል ያለ ምዕራፍ የሚወስድ አገናኝ።
     * ይህ የትርጉም የመጨረሻው ምዕራፍ ከሆነ ባዶ ነው።
     */
    nextChapterLink: string | null;

    /**
     * ወደ ቀዳሚው ቀለል ያለ ምዕራፍ የሚወስድ አገናኝ።
     * ይህ በትርጉሙ ውስጥ የመጀመሪያው ምዕራፍ ከሆነ ባዶ ነው።
     */
    previousChapterLink: string | null;

    /**
     * ወደ እነዚህ ማብራሪያዎች የሚወስድ አገናኝ።
     */
    thisChapterWordsLink: string;

    /**
     * ለሚቀጥለው ምዕራፍ ወደ ማብራሪያዎች የሚወስድ አገናኝ።
     * ይህ በትርጉሙ ውስጥ የመጨረሻው ምዕራፍ ከሆነ ወይም የሚቀጥለው ምዕራፍ በቃላት ደረጃ ምንም አይነት ማብራሪያ ከሌለው ባዶ ነው።
     */
    nextChapterWordsLink: string | null;

    /**
     * ወደ ቀዳሚው ምዕራፍ ወደ ማብራሪያዎች የሚወስድ አገናኝ።
     * ይህ በትርጉሙ ውስጥ የመጀመሪያው ምዕራፍ ከሆነ ወይም የቀደመው ምዕራፍ በቃላት ደረጃ ማብራሪያ ከሌለው ባዶ ነው።
     */
    previousChapterWordsLink: string | null;

    /**
     * በምዕራፉ ውስጥ ለእያንዳንዱ ጥቅስ የተገለጹ ቃላት፣ በቁጥር ቁጥር የተጻፉ።
     * እያንዳንዱ ዝርዝር ቃላቱ በጥቅሱ ውስጥ በተከሰቱበት ቅደም ተከተል ነው።
     */
    verses: {
        [verseNumber: string]: SimpleChapterWord[];
    };
}

/**
 * በቀላል ምዕራፍ ውስጥ የቃላት ደረጃ ማብራሪያ።
 */
export interface SimpleChapterWord {
    /**
     * በጥቅሱ ጽሑፍ ውስጥ የተብራራው ቃል የመጀመሪያ ቁምፊ ማውጫ።
     */
    start: number;

    /**
     * በግጥሙ ጽሑፍ ውስጥ ከተብራራው ቃል የመጨረሻ ቁምፊ በኋላ ያለው ማውጫ።
     */
    end: number;

    /**
     * የቃሉ የጠንካራው ቁጥሮች።
     */
    strongs?: string[];

    /**
     * የቃሉ ሌማ (የመዝገበ-ቃላት ቅጽ) በምንጭ ቋንቋ።
     */
    lemma?: string;

    /**
     * የቃሉ ሞርፎሎጂ በምንጭ ቋንቋ።
     */
    morph?: string;

    /**
     * በምንጭ ጽሑፍ ውስጥ የቃሉ ቦታ።
     */
    srcloc?: string;

    /**
     * ይህ በጥቅሱ ውስጥ የተጠቀሰው ቃል የትኛው መከሰት ነው።
     */
    occurrence?: number;

    /**
     * ቃሉ በጥቅሱ ውስጥ የተከሰተበት ጊዜ ብዛት።
     */
    occurrences?: number;
}

/**
 * የተቃለለውን የምዕራፍ ቅርጸት በመጠቀም የተሟላ የትርጉም ማውረድ ውሂብን ይገልጻል።
 * ወደ /api/:translationId/complete.simple.json የመጨረሻ ነጥብ የሚወስዱ ካርታዎች።
 */
export interface SimpleTranslationComplete {
    /**
     * የትርጉም ሜታዳታ።
     */
    translation: Translation;

    /**
     * የመጽሐፎቹ ሙሉ ዝርዝር ከሁሉም ምዕራፎቻቸው ጋር።
     */
    books: SimpleTranslationCompleteBook[];
}

/**
 * ቀለል ባለ የምዕራፍ ቅርጸት በመጠቀም ሙሉ የትርጉም ማውረድ የሚችል መጽሐፍ።
 */
export interface SimpleTranslationCompleteBook extends Omit<TranslationCompleteBook, 'chapters'> {
    /**
     * ሙሉውን የምዕራፎች ዝርዝር የያዘ ሲሆን ሁሉንም ይዘቶች ያካትታል።
     */
    chapters: SimpleTranslationCompleteChapter[];
}

/**
 * ቀለል ባለ የምዕራፍ ቅርጸት በመጠቀም ሙሉ የትርጉም ማውረድ ምዕራፍ።
 */
export interface SimpleTranslationCompleteChapter {
    /**
     * ምዕራፉ የያዘው የቁጥሮች ብዛት።
     */
    numberOfVerses: number;

    /**
     * ለምዕራፉ የተለያዩ የድምጽ ስሪቶች አገናኞች።
     */
    thisChapterAudioLinks: TranslationBookChapterAudioLinks;

    /**
     * የምዕራፉ የድምጽ ጊዜ (በአንድ-ቁጥር የሚጀምርበት ጊዜ፣ በሰከንዶች)።
     *
     * ሙሉ የትርጉም ፋይሎቹ የጊዜ ሰሌዳዎቹን እራሳቸው እንደያዙ ልብ ይበሉ (በመደበኛ ቅርጸት ሰነዶች ውስጥ የTranslateBookChapterAudioTimingsMap ን ይመልከቱ)፣ ወደ እነሱ የሚወስዱ አገናኞችን የያዙ የግለሰብ ምዕራፍ የመጨረሻ ነጥቦች ሳይሆኑ።
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * ለምዕራፉ የቃላት ደረጃ ማብራሪያዎች የሚወስድ አገናኝ፣ ቀለል ባለ ቅርጸት። ምዕራፉ ምንም አይነት የቃላት ደረጃ ማብራሪያዎች ከሌሉት ተትቷል።
     */
    thisChapterWordsLink?: string;

    /**
     * ለምዕራፉ የቀረበው ቀለል ያለ መረጃ።
     */
    chapter: SimpleChapterData;
}