መደበኛ ቅርጸት

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

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

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

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

    /**
     * ለምዕራፉ የተለያዩ የድምጽ ስሪቶች የድምጽ ጊዜዎች አገናኞች።
     * እያንዳንዱ አገናኝ ለዚያ አንባቢ የድምጽ ጊዜ ፋይሉን ይጠቁማል - ከታች "ለአንድ ምዕራፍ የድምጽ ጊዜ ፈልግ" የሚለውን ይመልከቱ።
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsLinks;

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

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

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

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

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

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

    /**
     * ለምዕራፉ የቃላት ደረጃ ማብራሪያዎች አገናኝ።
     * ምዕራፉ በቃላት ደረጃ ምንም አይነት ማብራሪያ ከሌለው ይሰረዛል።
     */
    thisChapterWordsLink?: string;

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

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

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

    /**
     * ወደዚህ ምዕራፍ ቀለል ወዳለው ስሪት የሚወስድ አገናኝ።
     * የተቀረጹ ምዕራፎች ከሌሉ ተትቷል።
     */
    simpleChapterApiLink?: string;

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

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

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

    /**
     * የምዕራፉ የግርጌ ማስታወሻዎች ዝርዝር።
     */
    footnotes: ChapterFootnote[];
}

/**
 * የአንድ የምዕራፍ ይዘት አንድ ክፍል የሚወክል የህብረት አይነት።
 * የምዕራፍ ይዘት ከሚከተሉት ነገሮች አንዱ ሊሆን ይችላል፡
 * - ርዕስ።
 * - የመስመር መግቻ።
 * - አንድ ጥቅስ።
 * - የዕብራይስጥ ንዑስ ርዕስ።
 */
type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

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

    /**
     * ለርዕሱ ይዘት።
     * በርካታ ሕብረቁምፊዎች በአደራደሩ ውስጥ ከተካተቱ፣ ከቦታ ጋር መያያዝ አለባቸው።
     */
    content: string[];
}

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

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

    /**
     * በንዑስ ጽሑፉ ውስጥ የተካተተው የይዘት ዝርዝር።
     * በዝርዝሩ ውስጥ ያለው እያንዳንዱ አካል ሕብረቁምፊ፣ የተቀረጸ ጽሑፍ ወይም የግርጌ ማስታወሻ ማጣቀሻ ሊሆን ይችላል።
     */
    content: (string | FormattedText | VerseFootnoteReference)[];
}

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

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

    /**
     * የጥቅሱ ይዘት ዝርዝር።
     * በዝርዝሩ ውስጥ ያለው እያንዳንዱ አካል ሕብረቁምፊ፣ የተቀረጸ ጽሑፍ ወይም የግርጌ ማስታወሻ ማጣቀሻ ሊሆን ይችላል።
     */
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

/**
 * የተቀረጸ ጽሑፍ። ማለትም፣ በተወሰነ መንገድ የተቀረጸ ጽሑፍ።
 */
interface FormattedText {
    /**
     * የተቀረጸው ጽሑፍ።
     */
    text: string;

    /**
     * ጽሑፉ ግጥምን ይወክል እንደሆነ።
     * ቁጥሩ የገባበትን ደረጃ ያሳያል።
     *
     * በመዝሙራት ውስጥ የተለመደ።
     */
    poem?: number;

    /**
     * ጽሑፉ የኢየሱስን ቃላት ይወክል እንደሆነ።
     */
    wordsOfJesus?: boolean;
}

/**
 * በአንድ ጥቅስ ውስጥ የተካተተ ርዕስን የሚወክል በይነገጽን ይገልጻል።
 */
interface InlineHeading {
    /**
     * የርዕሱ ጽሑፍ።
     */
    heading: string;
}

/**
 * በአንድ ጥቅስ ውስጥ የተከተተ የመስመር መግቻን የሚወክል በይነገጽን ይገልጻል።
 */
interface InlineLineBreak {
    lineBreak: true;
}


/**
 * በአንድ ጥቅስ ወይም በዕብራይስጥ ንዑስ ርዕስ ውስጥ የግርጌ ማስታወሻ ማጣቀሻ።
 */
interface VerseFootnoteReference {
    /**
     * የማስታወሻው መታወቂያ።
     */
    noteId: number;
}

/**
 * ስለ የግርጌ ማስታወሻ መረጃ።
 */
interface ChapterFootnote {
    /**
     * የተጠቀሰው ማስታወሻ መታወቂያ።
     */
    noteId: number;

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

    /**
     * የግርጌ ማስታወሻው የጥቅሱ ማጣቀሻ።
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * ለግርጌ ማስታወሻው ጥቅም ላይ መዋል ያለበት ደዋይ።
     * ለግርጌ ማስታወሻዎች፣ "ደዋይ" የሚለው ቃል በጽሑፉ ውስጥ የግርጌ ማስታወሻን ለማመልከት የሚያገለግል ገጸ-ባህሪ ነው።
     *
     * ለምሳሌ፣ በጽሑፉ ውስጥ፦
     * ሰላም (ሀ) ዓለም
     *
     * ---- (ሀ) ይህ የግርጌ ማስታወሻ ነው።
     *
     * "(ሀ)" የሚለው ደዋይ ነው።
     *
     * "+" ከሆነ ደዋዩ በራስ-ሰር መፈጠር አለበት።
     * ባዶ ከሆነ ደዋዩ ባዶ መሆን አለበት።
     * ሕብረቁምፊ ከሆነ፣ ደዋዩ ያ ሕብረቁምፊ መሆን አለበት።
     */
    caller: '+' | string | null;
}

/**
 * ለመጽሐፍ ምዕራፍ የድምጽ አገናኞች።
 */
interface TranslationBookChapterAudioLinks {
    /**
     * የምዕራፉ አንባቢ እና የዩአርኤል አገናኝ ወደ ኦዲዮ ፋይሉ።
     */
    [reader: string]: string;
}

/**
 * የድምፅ ጊዜዎች ለመጽሐፍ ምዕራፍ አገናኞች ናቸው።
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * የምዕራፉ አንባቢ እና የኤፒአይ አገናኝ ለዚያ አንባቢ የድምጽ ጊዜ ፋይሉ።
     */
    [reader: string]: string;
}

/**
 * ለአንድ የመጽሐፍ ምዕራፍ የድምጽ ጊዜዎችን፣ ለአንድ አንባቢ ይገልጻል።
 * ካርታዎች ወደ /api/{translation}/{book}/{chapter}.{reader}.audioTimings.json የመጨረሻ ነጥብ።
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * የትርጉሙ መታወቂያ።
     */
    translationId: string;

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

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

    /**
     * እነዚህ የጊዜ ሰሌዳዎች የሚያመለክቱበት የአንባቢው መታወቂያ።
     */
    reader: string;

    /**
     * እነዚህ የጊዜ ሰሌዳዎች የሚቀርቡበት የድምጽ ፋይል አገናኝ።
     */
    audioLink: string;

    /**
     * የዚህ ምዕራፍ መረጃ አገናኝ።
     */
    thisChapterLink: string;

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

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

    /**
     * ወደዚህ የድምጽ ጊዜ ፋይል የሚወስድ አገናኝ።
     */
    thisChapterAudioTimingsLink: string;

    /**
     * ለቀጣዩ ምዕራፍ የጊዜ ሰሌዳዎች የሚወስድ አገናኝ፣ ለተመሳሳይ አንባቢ።
     * ይህ የትርጉም የመጨረሻው ምዕራፍ ከሆነ ባዶ ነው።
     */
    nextChapterAudioTimingsLink: string | null;

    /**
     * ለቀድሞው ምዕራፍ የጊዜ ሰሌዳዎች የሚወስድ አገናኝ፣ ለተመሳሳይ አንባቢ።
     * ይህ በትርጉሙ ውስጥ የመጀመሪያው ምዕራፍ ከሆነ ባዶ ነው።
     */
    previousChapterAudioTimingsLink: string | null;

    /**
     * እያንዳንዱ ጥቅስ የሚጀምርባቸው ሰከንዶች፣ በቅደም ተከተል።
     * የመጀመሪያው ቁጥር (ኢንዴክስ 0) የመጀመሪያው ቁጥር የሚጀምርበት ጊዜ በመዝገብ ውስጥ ነው።
     */
    verses: number[];
}

export interface TranslationBookChapterWords {
    /**
     * የትርጉሙ መታወቂያ።
     */
    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]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * ማብራሪያው የሚመለከተው በቁጥሩ የይዘት አደራደር ውስጥ ያለው የእቃው ማውጫ።
     */
    contentIndex: number;

    /**
     * በይዘት ንጥሉ ጽሑፍ ውስጥ የተብራራው ቃል የመጀመሪያ ቁምፊ ማውጫ።
     */
    start: number;

    /**
     * በይዘት ንጥሉ ጽሑፍ ውስጥ ከተብራራው ቃል የመጨረሻ ቁምፊ በኋላ ያለው መረጃ ጠቋሚ።
     * ማለትም፣ text.slice(መጀመሪያ፣ መጨረሻ) የተብራራው ቃል ነው።
     */
    end: number;

    /**
     * የቃሉ የጠንካራው ቁጥር(ዎች)።
     * ትርጉሙ ለቃሉ ሌሎች ማብራሪያዎችን ብቻ ካቀረበ ችላ ተብሏል።
     */
    strongs?: string[];

    /**
     * የቃሉ መዝገበ-ቃላት (የጥቅስ) ቅርፅ።
     * ትርጉሙ ካልሰጠ ተትቷል።
     */
    lemma?: string;

    /**
     * የቃሉ የሞርፎሎጂ ትንተና ኮድ።
     * ትርጉሙ ካልሰጠ ተትቷል።
     */
    morph?: string;

    /**
     * በምንጭ ጽሑፉ ውስጥ ወዳለው ቃል የሚጠቁመው ጠቋሚ፣ በ <sourceName> <location> ቅርጸት።
     * ትርጉሙ ካልሰጠ ተትቷል።
     */
    srcloc?: string;

    /**
     * የዚህ ቃል የምንጭ ቃል መከሰት በየትኛው ላይ የተመሠረተ ነው። 1-የተመሰረተ።
     * ትርጉሙ ካልሰጠ ተትቷል።
     */
    occurrence?: number;

    /**
     * የምንጭ ቃሉ የተከሰተበት ጠቅላላ ጊዜ ብዛት።
     * ትርጉሙ ካልሰጠ ተትቷል።
     */
    occurrences?: number;
}

/**
 * ሙሉውን የትርጉም ማውረድ ውሂብ ይገልጻል።
 * ወደ /api/:translationId/complete.json የመጨረሻ ነጥብ የሚወስዱ ካርታዎች።
 */
export interface TranslationComplete {
    /**
     * የትርጉም ሜታዳታ።
     */
    translation: Translation;

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

/**
 * ሙሉ የትርጉም ማውረድ ላይ ያለ መጽሐፍ።
 */
export interface TranslationCompleteBook {
    /**
     * የመጽሐፉ መታወቂያ።
     */
    id: string;

    /**
     * የመጽሐፉ ስም ከትርጉሙ።
     */
    name: string;

    /**
     * የመጽሐፉ የተለመደ ስም።
     */
    commonName: string;

    /**
     * የመጽሐፉ ርዕስ።
     */
    title: string | null;

    /**
     * የመጽሐፉ ቅደም ተከተል።
     */
    order: number;

    /**
     * በመጽሐፉ ውስጥ ያሉት የምዕራፎች ብዛት።
     */
    numberOfChapters: number;

    /**
     * በመጽሐፉ ውስጥ ያሉት አጠቃላይ የጥቅሶች ብዛት።
     */
    totalNumberOfVerses: number;

    /**
     * መጽሐፉ አፖክሪፋዊ ይሁን።
     */
    isApocryphal?: boolean;

    /**
     * ሙሉውን የምዕራፎች ዝርዝር የያዘ ሲሆን ሁሉንም ይዘቶች ያካትታል።
     */
    chapters: TranslationCompleteChapter[];
}

/**
 * ሙሉ የትርጉም ማውረድ ላይ አንድ ምዕራፍ።
 */
export interface TranslationCompleteChapter {
    /**
     * ምዕራፉ የያዘው የቁጥሮች ብዛት።
     */
    numberOfVerses: number;

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

    /**
     * ለምዕራፉ የተለያዩ የድምጽ ስሪቶች የድምጽ ጊዜ (በአንድ-ቁጥር የሚጀምሩበት ጊዜ፣ በሰከንዶች)።
     *
     * በእያንዳንዱ የምዕራፍ መጨረሻ ላይ ካለው `thisChapterAudioTimings` በተለየ (ከታች "ለአንድ ምዕራፍ የድምጽ ጊዜዎችን ያግኙ" የሚለውን የሚያገናኝ)፣ ይህ የጊዜ ሰሌዳዎቹን እራሳቸው ይይዛል - ምክንያቱም ሙሉውን የትርጉም ማውረድ ዋናው ነገር ሁሉንም ነገር በአንድ ፋይል ውስጥ ማስቀመጥ ነው።
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * ለምዕራፉ የቃላት ደረጃ ማብራሪያዎች አገናኝ።
     * ምዕራፉ በቃላት ደረጃ ምንም አይነት ማብራሪያ ከሌለው ይሰረዛል።
     */
    thisChapterWordsLink?: string;

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

/**
 * የመጽሐፍ ምዕራፍ የድምጽ ጊዜዎች፣ በቀጥታ ከተገናኘው ይልቅ ተካትተዋል።
 * የአንባቢ መታወቂያን እያንዳንዱ ጥቅስ የሚጀምረውን የጊዜ ዝርዝር (በሰከንዶች)፣ በቁጥር ቅደም ተከተል ያስቀምጣል።
 */
interface TranslationBookChapterAudioTimingsMap {
    [reader: string]: number[];
}