مجموعات البيانات

export interface AvailableDatasets {
    /**
     * قائمة مجموعات البيانات.
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * معرف مجموعة البيانات.
     */
    id: string;

    /**
     * اسم مجموعة البيانات.
     */
    name: string;

    /**
     * موقع الويب الخاص بمجموعة البيانات.
     */
    website: string;

    /**
     * عنوان URL الذي يمكن من خلاله العثور على ترخيص مجموعة البيانات.
     */
    licenseUrl: string;

    /**
     * الاسم الإنجليزي لمجموعة البيانات.
     */
    englishName: string;

    /**
     * رمز اللغة المكون من 3 أحرف وفقًا لمعيار ISO 639 والذي توجد به مجموعة البيانات بشكل أساسي.
     */
    language: string;

    /**
     * الاتجاه الذي تُكتب به اللغة.
     * يشير الرمز "ltr" إلى أن النص مكتوب من الجانب الأيسر للصفحة إلى الجانب الأيمن.
     * يشير الرمز "rtl" إلى أن النص مكتوب من الجانب الأيمن للصفحة إلى الجانب الأيسر.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * رابط واجهة برمجة التطبيقات (API) لقائمة الكتب المتاحة لهذه المجموعة من البيانات.
     */
    listOfBooksApiLink: string;

    /**
     * قائمة التنسيقات المتاحة.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * عدد الكتب الموجودة في هذه المجموعة من البيانات.
     */
    numberOfBooks: number;

    /**
     * إجمالي عدد الفصول الموجودة في مجموعة البيانات هذه.
     */
    totalNumberOfChapters: number;

    /**
     * إجمالي عدد الآيات الموجودة في هذه المجموعة من البيانات.
     */
    totalNumberOfVerses: number;

    /**
     * إجمالي عدد المراجع المتقاطعة الموجودة في مجموعة البيانات هذه.
     */
    totalNumberOfReferences: number;

    /**
     * يحصل على اسم اللغة التي توجد بها مجموعة البيانات.
     * تكون القيمة فارغة أو غير محددة إذا كان اسم اللغة غير معروف.
     */
    languageName?: string;

    /**
     * يحصل على اسم اللغة باللغة الإنجليزية.
     * قيمة فارغة أو غير محددة إذا لم يكن للغة اسم إنجليزي.
     */
    languageEnglishName?: string;

    /**
     * روابط واجهة برمجة التطبيقات (API) لقوائم الكيانات في مجموعة البيانات.
     * يتم حذفها إذا لم تحتوي مجموعة البيانات على الكيانات المقابلة.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * إجمالي عدد الكيانات الموجودة في مجموعة البيانات.
     * يتم حذفها إذا لم تحتوي مجموعة البيانات على الكيانات المقابلة.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * معلومات مجموعة البيانات الخاصة بالكتب.
     */
    dataset: Dataset;

    /**
     * قائمة الكتب المتاحة لمجموعة البيانات.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * رقم تعريف الكتاب.
     * يطابق معرف الكتاب المقابل في الكتاب المقدس (سفر التكوين، سفر الخروج، إلخ).
     */
    id: string;

    /**
     * ترتيب الكتاب في الكتاب المقدس.
     */
    order: number;

    /**
     * رقم الفصل الأول في الكتاب.
     */
    firstChapterNumber: number;

    /**
     * رابط الفصل الأول من الكتاب.
     */
    firstChapterApiLink: string | null;

    /**
     * رقم الفصل الأخير في الكتاب.
     */
    lastChapterNumber: number | null;

    /**
     * رابط الفصل الأخير من الكتاب.
     */
    lastChapterApiLink: string | null;

    /**
     * عدد الفصول التي يحتويها الكتاب.
     */
    numberOfChapters: number;

    /**
     * عدد الآيات التي يحتويها الكتاب.
     */
    totalNumberOfVerses: number;

    /**
     * إجمالي عدد الإحالات المرجعية التي يحتويها هذا الكتاب.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * معلومات مجموعة البيانات الخاصة بفصل الكتاب.
     */
    dataset: Dataset;

    /**
     * معلومات الكتاب الخاصة بفصل الكتاب.
     */
    book: DatasetBook;

    /**
     * رابط هذا الفصل.
     */
    thisChapterLink: string;

    /**
     * رابط الفصل التالي.
     * قيمة فارغة إذا كان هذا هو الفصل الأخير في مجموعة البيانات.
     */
    nextChapterApiLink: string | null;

    /**
     * رابط الفصل السابق.
     * قيمة فارغة إذا كان هذا هو الفصل الأول في مجموعة البيانات.
     */
    previousChapterApiLink: string | null;

    /**
     * عدد الآيات التي يحتويها الفصل.
     */
    numberOfVerses: number;

    /**
     * المعلومات الخاصة بهذا الفصل.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * رقم الفصل.
     */
    number: number;

    /**
     * محتوى الفصل.
     */
    content: DatasetVerse[];
}

interface DatasetVerse {
    /**
     * رقم الآية.
     */
    verse: number;

    /**
     * المراجع المتقاطعة للآية.
     *
     * مرتبة حسب النتيجة، تنازلياً.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * رقم تعريف الكتاب الذي تتم الإشارة إليه.
     */
    book: string;

    /**
     * رقم الفصل.
     */
    chapter: number;

    /**
     * رقم الآية.
     * إذا كان `endVerse` موجودًا، فهذه هي الآية التي يبدأ منها المرجع.
     */
    verse: number;

    /**
     * الآية التي ينتهي عندها المرجع.
     */
    endVerse?: number;

    /**
     * درجة الصلة بالمرجع.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * معرّف الكيان الذي تتم الإشارة إليه.
     */
    id: string;

    /**
     * نوع الكيان الذي تتم الإشارة إليه.
     * يتطابق مع جزء المجموعة من رابط واجهة برمجة التطبيقات للكيان، لذلك يمكن إنشاء الرابط على أنه `/api/d/{dataset}/{type}/{id}.json` .
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * اسم الكيان الذي تتم الإشارة إليه.
     */
    name?: string;

    /**
     * رابط واجهة برمجة التطبيقات (API) للكيان الذي تتم الإشارة إليه.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * معرف الكتاب (GEN، EXO، إلخ).
     */
    book: string;

    /**
     * رقم الفصل الذي يبدأ منه المرجع.
     */
    chapter: number;

    /**
     * رقم الآية التي يبدأ منها المرجع.
     */
    verse: number;

    /**
     * الآية التي ينتهي عندها المرجع.
     * يتم دمج الآيات المتتالية في نفس الفصل في مرجع واحد.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * معلومات مجموعة البيانات الخاصة بفصل الكتاب.
     */
    dataset: Dataset;

    /**
     * معلومات الكتاب الخاصة بفصل الكتاب.
     */
    book: DatasetBook;

    /**
     * بيانات الكيان الخاصة بالفصل.
     */
    chapter: DatasetEntityChapterData;

    /**
     * رابط هذا الفصل.
     */
    thisChapterLink: string;

    /**
     * رابط الفصل التالي.
     * قيمة فارغة إذا كان هذا هو الفصل الأخير في مجموعة البيانات.
     */
    nextChapterApiLink: string | null;

    /**
     * رابط الفصل السابق.
     * قيمة فارغة إذا كان هذا هو الفصل الأول في مجموعة البيانات.
     */
    previousChapterApiLink: string | null;

    /**
     * عدد الأشخاص والأماكن والأحداث التي تظهر في الفصل.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * رقم الفصل.
     */
    number: number;

    /**
     * الأشخاص الذين يظهرون في الفصل.
     * مرتبة حسب أول بيت شعري تظهر فيه.
     */
    people: ChapterPerson[];

    /**
     * الأماكن التي تظهر في الفصل.
     * مرتبة حسب أول بيت شعري تظهر فيه.
     */
    places: ChapterPlace[];

    /**
     * الأحداث التي تظهر في الفصل.
     * مرتبة حسب أول بيت شعري تظهر فيه.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * هوية الشخص.
     */
    id: string;

    /**
     * اسم الشخص.
     */
    name: string;

    /**
     * ما إذا كان اسم الشخص اسماً صحيحاً.
     */
    isProperName?: boolean;

    /**
     * جنس الشخص.
     */
    gender?: string;

    /**
     * السنة التي ولد فيها الشخص والسنة التي توفي فيها.
     * الأرقام السالبة تمثل سنوات قبل الميلاد. الأرقام الموجبة تمثل سنوات بعد الميلاد.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * رابط واجهة برمجة التطبيقات (API) الخاص بالشخص.
     */
    apiLink: string;

    /**
     * أرقام الآيات في الفصل التي تذكر الشخص.
     * مرتبة تصاعدياً.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * هوية المكان.
     */
    id: string;

    /**
     * اسم المكان.
     */
    name: string;

    /**
     * نوع السمة الجغرافية التي يمثلها المكان.
     */
    featureType?: string;

    /**
     * خط العرض وخط الطول للمكان.
     */
    latitude?: number;
    longitude?: number;

    /**
     * رابط واجهة برمجة التطبيقات (API) الخاص بالمكان.
     */
    apiLink: string;

    /**
     * أرقام الآيات في الفصل التي تذكر المكان.
     * مرتبة تصاعدياً.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * معرف الحدث.
     */
    id: string;

    /**
     * اسم الحدث.
     */
    name: string;

    /**
     * تاريخ بدء الحدث.
     */
    startDate?: string;

    /**
     * رابط واجهة برمجة التطبيقات (API) الخاص بالحدث.
     */
    apiLink: string;

    /**
     * أرقام الآيات في الفصل التي تصف الحدث.
     * مرتبة تصاعدياً.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * معلومات مجموعة البيانات للأشخاص.
     */
    dataset: Dataset;

    /**
     * قائمة الأشخاص المتاحين لمجموعة البيانات.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * هوية الشخص.
     */
    id: string;

    /**
     * اسم الشخص.
     */
    name: string;

    /**
     * ما إذا كان اسم الشخص اسماً صحيحاً.
     */
    isProperName?: boolean;

    /**
     * جنس الشخص.
     */
    gender?: string;

    /**
     * عدد المراجع الكتابية التي تذكر الشخص.
     */
    numberOfReferences: number;

    /**
     * رابط واجهة برمجة التطبيقات (API) الخاص بالشخص.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * معلومات مجموعة البيانات الخاصة بالشخص.
     */
    dataset: Dataset;

    /**
     * المعلومات المتعلقة بالشخص.
     */
    person: DatasetPerson;

    /**
     * رابط واجهة برمجة التطبيقات (API) الخاص بهذا الشخص.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * هوية الشخص.
     */
    id: string;

    /**
     * اسم الشخص.
     */
    name: string;

    /**
     * أسماء أخرى يُنادى بها الشخص.
     */
    alsoCalled?: string[];

    /**
     * ما إذا كان اسم الشخص اسماً صحيحاً.
     */
    isProperName?: boolean;

    /**
     * جنس الشخص.
     */
    gender?: string;

    /**
     * وصف الشخص. كل سطر يمثل فقرة.
     */
    description?: string[];

    /**
     * السنة التي ولد فيها الشخص والسنة التي توفي فيها.
     * الأرقام السالبة تمثل سنوات قبل الميلاد. الأرقام الموجبة تمثل سنوات بعد الميلاد.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * أقدم وأحدث السنوات التي ذُكر فيها الشخص.
     */
    minYear?: number;
    maxYear?: number;

    /**
     * المكان الذي ولد فيه الشخص ومات فيه.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * العلاقات الأسرية للشخص.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * المجموعات السكانية التي ينتمي إليها الشخص.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * الأحداث التي شارك فيها الشخص.
     */
    events?: DatasetEntityRef[];

    /**
     * قائمة المراجع الكتابية التي تذكر الشخص.
     * مرتبة حسب ترتيب الكتاب والفصل والآية.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * معلومات مجموعة البيانات الخاصة بالأماكن.
     */
    dataset: Dataset;

    /**
     * قائمة الأماكن المتاحة لمجموعة البيانات.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * هوية المكان.
     */
    id: string;

    /**
     * اسم المكان.
     */
    name: string;

    /**
     * نوع السمة الجغرافية التي يمثلها المكان.
     * على سبيل المثال، "مدينة"، "منطقة"، "جبل"، "ماء"، إلخ.
     */
    featureType?: string;

    /**
     * خط العرض وخط الطول للمكان.
     */
    latitude?: number;
    longitude?: number;

    /**
     * عدد المراجع الكتابية التي تذكر المكان.
     */
    numberOfReferences: number;

    /**
     * رابط واجهة برمجة التطبيقات (API) الخاص بالمكان.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * معلومات مجموعة البيانات الخاصة بالمكان.
     */
    dataset: Dataset;

    /**
     * المعلومات المتعلقة بالمكان.
     */
    place: DatasetPlace;

    /**
     * رابط واجهة برمجة التطبيقات (API) لهذا الموقع.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * هوية المكان.
     */
    id: string;

    /**
     * اسم المكان.
     */
    name: string;

    /**
     * اسم المكان كما يظهر في نسخة الملك جيمس والنسخة الإنجليزية القياسية.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * أسماء أخرى يُطلق عليها هذا المكان.
     */
    aliases?: string[];

    /**
     * نوع السمة الجغرافية التي يمثلها المكان.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * خط العرض وخط الطول للمكان، ومدى دقتهما.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * وصف المكان. كل سطر يمثل فقرة.
     */
    description?: string[];

    /**
     * تعليق مؤلفي مجموعة البيانات على المكان.
     */
    comment?: string;

    /**
     * المكان الأصلي لهذا المكان.
     * تشترك الأسماء المختلفة لنفس الموقع الجغرافي في نفس الأصل المكاني.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * المكان الذي يُعد هذا المكان نسخة طبق الأصل منه.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * الأشخاص الذين كانوا في هذا المكان، أو ولدوا فيه، أو ماتوا فيه.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * الأحداث التي وقعت في ذلك المكان.
     */
    events?: DatasetEntityRef[];

    /**
     * قائمة المراجع الكتابية التي تذكر المكان.
     * مرتبة حسب ترتيب الكتاب والفصل والآية.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * معلومات مجموعة البيانات الخاصة بالأحداث.
     */
    dataset: Dataset;

    /**
     * قائمة الأحداث المتاحة لمجموعة البيانات.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * معرف الحدث.
     */
    id: string;

    /**
     * اسم الحدث.
     */
    name: string;

    /**
     * تاريخ بدء الحدث.
     * الأرقام السالبة تمثل سنوات قبل الميلاد. الأرقام الموجبة تمثل سنوات بعد الميلاد.
     * تستخدم التواريخ الأكثر تحديدًا تنسيق `YYYY-MM-DD` .
     */
    startDate?: string;

    /**
     * عدد الإشارات الكتابية التي تصف الحدث.
     */
    numberOfReferences: number;

    /**
     * رابط واجهة برمجة التطبيقات (API) الخاص بالحدث.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * معلومات مجموعة البيانات الخاصة بالحدث.
     */
    dataset: Dataset;

    /**
     * معلومات عن الحدث.
     */
    event: DatasetEvent;

    /**
     * رابط واجهة برمجة التطبيقات (API) لهذا الحدث.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * معرف الحدث.
     */
    id: string;

    /**
     * اسم الحدث.
     */
    name: string;

    /**
     * تاريخ بدء الحدث.
     */
    startDate?: string;

    /**
     * مدة الحدث.
     * على سبيل المثال، "1D" تعني يومًا واحدًا و"40Y" تعني أربعين عامًا.
     */
    duration?: string;

    /**
     * الأشخاص الذين شاركوا في الحدث.
     */
    participants?: DatasetEntityRef[];

    /**
     * الأماكن التي وقع فيها الحدث.
     */
    locations?: DatasetEntityRef[];

    /**
     * المجموعات السكانية التي شاركت في الحدث.
     */
    groups?: DatasetEntityRef[];

    /**
     * الحدث الذي يُعد هذا الحدث جزءًا منه.
     */
    partOf?: DatasetEntityRef;

    /**
     * الحدث الذي وقع قبل هذا الحدث.
     */
    predecessor?: DatasetEntityRef;

    /**
     * قائمة المراجع الكتابية التي تصف الحدث.
     * مرتبة حسب ترتيب الكتاب والفصل والآية.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * معلومات مجموعة البيانات الخاصة بالمجموعات السكانية.
     */
    dataset: Dataset;

    /**
     * قائمة مجموعات الأشخاص المتاحة لمجموعة البيانات.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * هوية المجموعة السكانية.
     */
    id: string;

    /**
     * اسم المجموعة الشعبية.
     */
    name: string;

    /**
     * عدد الأشخاص الذين ينتمون إلى المجموعة السكانية.
     */
    numberOfMembers: number;

    /**
     * رابط واجهة برمجة التطبيقات (API) لمجموعة الأشخاص.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * معلومات مجموعة البيانات الخاصة بمجموعة الأشخاص.
     */
    dataset: Dataset;

    /**
     * المعلومات المتعلقة بالجماعة السكانية.
     */
    group: DatasetPeopleGroup;

    /**
     * رابط واجهة برمجة التطبيقات (API) لهذه المجموعة من الأشخاص.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * هوية المجموعة السكانية.
     */
    id: string;

    /**
     * اسم المجموعة الشعبية.
     */
    name: string;

    /**
     * الأشخاص الذين ينتمون إلى مجموعة الناس.
     */
    members?: DatasetEntityRef[];

    /**
     * الأحداث التي شاركت فيها المجموعة الشعبية.
     */
    events?: DatasetEntityRef[];

    /**
     * قائمة المراجع الكتابية التي تذكر هذه المجموعة من الناس.
     * مرتبة حسب ترتيب الكتاب والفصل والآية.
     */
    references: VerseRef[];
}