معیاری شکل

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 {
    /**
     * اس نوٹ کی ID جس کا حوالہ دیا گیا ہے۔
     */
    noteId: number;

    /**
     * فوٹ نوٹ کا متن۔
     */
    text: string;

    /**
     * حاشیہ کے لیے آیت کا حوالہ۔
     */
    reference?: {
        chapter: number;
        verse: number;
    };

    /**
     * کال کرنے والا جو فوٹ نوٹ کے لیے استعمال کیا جانا چاہیے۔
     * فوٹ نوٹ کے لیے، "کالر" وہ حرف ہے جو متن میں فوٹ نوٹ کے حوالے سے استعمال ہوتا ہے۔
     *
     * مثال کے طور پر، متن میں:
     * ہیلو (a) دنیا
     *
     * ---- (a) یہ ایک فوٹ نوٹ ہے۔
     *
     * "(a)" پکارنے والا ہے۔
     *
     * اگر "+"، تو کالر خود کار طریقے سے تیار کیا جانا چاہئے.
     * اگر کالعدم ہے، تو کالر خالی ہونا چاہیے۔
     * اگر ایک تار ہے، تو کالر وہ تار ہونا چاہیے۔
     */
    caller: '+' | string | null;
}

/**
 * کتاب کے باب کے لیے آڈیو لنکس۔
 */
interface TranslationBookChapterAudioLinks {
    /**
     * باب کا قاری اور آڈیو فائل کا URL لنک۔
     */
    [reader: string]: string;
}

/**
 * کتاب کے باب کے لیے آڈیو ٹائمنگ لنکس۔
 */
interface TranslationBookChapterAudioTimingsLinks {
    /**
     * باب کا ریڈر اور اس ریڈر کے لیے آڈیو ٹائمنگ فائل سے API لنک۔
     */
    [reader: string]: string;
}

/**
 * کسی ایک قاری کے لیے کتاب کے باب کے لیے آڈیو اوقات کی وضاحت کرتا ہے۔
 * /api/{translation}/{book}/{chapter} کے نقشے{reader}.audioTimings.json اینڈ پوائنٹ۔
 */
export interface TranslationBookChapterAudioTimings {
    /**
     * ترجمہ کی ID۔
     */
    translationId: string;

    /**
     * کتاب کی شناخت۔
     */
    bookId: string;

    /**
     * باب کا نمبر۔
     */
    chapterNumber: number;

    /**
     * قاری کی ID جس کے لیے یہ اوقات ہیں۔
     */
    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 {
    /**
     * ترجمہ کی 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]: ChapterWord[];
    };
}

interface ChapterWord {
    /**
     * آیت کے مواد کی صف میں آئٹم کا اشاریہ جس پر تشریح کا اطلاق ہوتا ہے۔
     */
    contentIndex: number;

    /**
     * مواد کے آئٹم کے متن میں تشریح شدہ لفظ کے پہلے حرف کا اشاریہ۔
     */
    start: number;

    /**
     * مواد کے آئٹم کے متن میں تشریح شدہ لفظ کے آخری حرف کے بعد کا اشاریہ۔
     * یعنی text.slice(start, end) تشریح شدہ لفظ ہے۔
     */
    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[];
}