آسان فارمیٹ

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 {
    /**
     * ترجمہ کی ID۔
     */
    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;

    /**
     * باب کے لیے آڈیو اوقات (فی آیت کے آغاز کے اوقات، سیکنڈ میں)۔
     *
     * نوٹ کریں کہ مکمل ترجمے کی فائلوں میں اوقات خود ہوتے ہیں (معیاری فارمیٹ دستاویزات میں TranslationBookChapterAudioTimingsMap دیکھیں)، انفرادی باب کے اختتامی نکات کے برعکس، جس میں ان کے لنکس ہوتے ہیں۔
     */
    thisChapterAudioTimings: TranslationBookChapterAudioTimingsMap;

    /**
     * باب کے لیے لفظی سطح کی تشریحات کا لنک، آسان فارمیٹ کا استعمال کرتے ہوئے۔ اگر باب میں لفظی سطح کی کوئی تشریحات نہیں ہیں تو چھوڑ دیا جائے گا۔
     */
    thisChapterWordsLink?: string;

    /**
     * باب کے لیے آسان معلومات۔
     */
    chapter: SimpleChapterData;
}