Seti za data

export interface AvailableDatasets {
    /**
     * Orodha ya seti za data.
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * Kitambulisho cha seti ya data.
     */
    id: string;

    /**
     * Jina la seti ya data.
     */
    name: string;

    /**
     * Tovuti ya seti ya data.
     */
    website: string;

    /**
     * URL ambayo leseni ya seti ya data inaweza kupatikana.
     */
    licenseUrl: string;

    /**
     * Jina la Kiingereza la seti ya data.
     */
    englishName: string;

    /**
     * Lebo ya lugha ya ISO 639 yenye herufi 3 ambayo seti ya data iko kimsingi.
     */
    language: string;

    /**
     * Mwelekeo ambao lugha imeandikwa.
     * "ltr" inaonyesha kwamba maandishi yameandikwa kutoka upande wa kushoto wa ukurasa kwenda kulia.
     * "rtl" inaonyesha kwamba maandishi yameandikwa kutoka upande wa kulia wa ukurasa kwenda kushoto.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * Kiungo cha API cha orodha ya vitabu vinavyopatikana kwa seti hii ya data.
     */
    listOfBooksApiLink: string;

    /**
     * Orodha inayopatikana ya miundo.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * Idadi ya vitabu vilivyomo katika seti hii ya data.
     */
    numberOfBooks: number;

    /**
     * Jumla ya idadi ya sura zilizomo katika seti hii ya data.
     */
    totalNumberOfChapters: number;

    /**
     * Jumla ya idadi ya mistari iliyomo katika seti hii ya data.
     */
    totalNumberOfVerses: number;

    /**
     * Jumla ya idadi ya marejeleo mtambuka yaliyomo katika seti hii ya data.
     */
    totalNumberOfReferences: number;

    /**
     * Hupata jina la lugha ambayo seti ya data iko.
     * Haifafanuliwa au haijafafanuliwa ikiwa jina la lugha halijulikani.
     */
    languageName?: string;

    /**
     * Anapata jina la lugha hiyo kwa Kiingereza.
     * Haijafafanuliwa au haijafafanuliwa ikiwa lugha haina jina la Kiingereza.
     */
    languageEnglishName?: string;

    /**
     * Viungo vya API vya orodha ya vitu vilivyo kwenye seti ya data.
     * Imeachwa ikiwa seti ya data haina vitu vinavyolingana.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * Jumla ya idadi ya vitu vilivyomo kwenye seti ya data.
     * Imeachwa ikiwa seti ya data haina vitu vinavyolingana.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * Taarifa za seti ya data kwa ajili ya vitabu.
     */
    dataset: Dataset;

    /**
     * Orodha ya vitabu vinavyopatikana kwa ajili ya seti ya data.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * Kitambulisho cha kitabu.
     * Inalingana na kitambulisho cha kitabu kinacholingana katika Biblia (GEN, EXO, n.k.).
     */
    id: string;

    /**
     * Mpangilio wa kitabu katika Biblia.
     */
    order: number;

    /**
     * Nambari ya sura ya kwanza katika kitabu.
     */
    firstChapterNumber: number;

    /**
     * Kiungo cha sura ya kwanza ya kitabu.
     */
    firstChapterApiLink: string | null;

    /**
     * Nambari ya sura ya mwisho katika kitabu.
     */
    lastChapterNumber: number | null;

    /**
     * Kiungo cha sura ya mwisho ya kitabu.
     */
    lastChapterApiLink: string | null;

    /**
     * Idadi ya sura ambazo kitabu kina.
     */
    numberOfChapters: number;

    /**
     * Idadi ya mistari iliyomo katika kitabu hicho.
     */
    totalNumberOfVerses: number;

    /**
     * Jumla ya marejeleo mtambuka ambayo kitabu hiki kina.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * Taarifa za seti ya data kwa sura ya kitabu.
     */
    dataset: Dataset;

    /**
     * Taarifa za kitabu kwa ajili ya sura ya kitabu.
     */
    book: DatasetBook;

    /**
     * Kiungo cha sura hii.
     */
    thisChapterLink: string;

    /**
     * Kiungo cha sura inayofuata.
     * Batilisha ikiwa hii ndiyo sura ya mwisho katika seti ya data.
     */
    nextChapterApiLink: string | null;

    /**
     * Kiungo cha sura iliyotangulia.
     * Batilisha ikiwa hii ni sura ya kwanza katika seti ya data.
     */
    previousChapterApiLink: string | null;

    /**
     * Idadi ya mistari ambayo sura hiyo ina.
     */
    numberOfVerses: number;

    /**
     * Taarifa kwa ajili ya sura.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * Idadi ya sura.
     */
    number: number;

    /**
     * Maudhui ya sura hiyo.
     */
    content: DatasetVerse[];
}

interface DatasetVerse {
    /**
     * Nambari ya mstari.
     */
    verse: number;

    /**
     * Marejeleo mtambuka ya mstari huo.
     *
     * Imepangwa kwa alama, ikishuka.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * Kitambulisho cha kitabu kinachorejelewa.
     */
    book: string;

    /**
     * Nambari ya sura.
     */
    chapter: number;

    /**
     * Nambari ya mstari.
     * Ikiwa `endVerse` ipo, basi huu ndio mstari ambao marejeleo yanaanza.
     */
    verse: number;

    /**
     * Mstari ambao marejeleo huishia.
     */
    endVerse?: number;

    /**
     * Alama muhimu kwa marejeleo.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * Kitambulisho cha huluki inayorejelewa.
     */
    id: string;

    /**
     * Aina ya huluki inayorejelewa.
     * Inalingana na sehemu ya mkusanyiko wa kiungo cha API cha huluki, kwa hivyo kiungo kinaweza kujengwa kama `/api/d/{dataset}/{type}/{id}.json` .
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * Jina la huluki inayorejelewa.
     */
    name?: string;

    /**
     * Kiungo cha API cha huluki inayorejelewa.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * Kitambulisho cha kitabu (GEN, EXO, n.k.).
     */
    book: string;

    /**
     * Nambari ya sura ambayo marejeleo yanaanza.
     */
    chapter: number;

    /**
     * Nambari ya mstari ambayo marejeleo yanaanza.
     */
    verse: number;

    /**
     * Mstari ambao marejeleo huishia.
     * Mistari mfululizo katika sura hiyo hiyo imekunjwa na kuwa marejeleo moja.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * Taarifa za seti ya data kwa sura ya kitabu.
     */
    dataset: Dataset;

    /**
     * Taarifa za kitabu kwa ajili ya sura ya kitabu.
     */
    book: DatasetBook;

    /**
     * Data ya chombo kwa ajili ya sura hiyo.
     */
    chapter: DatasetEntityChapterData;

    /**
     * Kiungo cha sura hii.
     */
    thisChapterLink: string;

    /**
     * Kiungo cha sura inayofuata.
     * Batilisha ikiwa hii ndiyo sura ya mwisho katika seti ya data.
     */
    nextChapterApiLink: string | null;

    /**
     * Kiungo cha sura iliyotangulia.
     * Batilisha ikiwa hii ni sura ya kwanza katika seti ya data.
     */
    previousChapterApiLink: string | null;

    /**
     * Idadi ya watu, maeneo, na matukio yanayoonekana katika sura hiyo.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * Idadi ya sura.
     */
    number: number;

    /**
     * Watu wanaoonekana katika sura hiyo.
     * Imepangwa kulingana na mstari wa kwanza ambao zinaonekana.
     */
    people: ChapterPerson[];

    /**
     * Sehemu zinazoonekana katika sura.
     * Imepangwa kulingana na mstari wa kwanza ambao zinaonekana.
     */
    places: ChapterPlace[];

    /**
     * Matukio yanayoonekana katika sura hiyo.
     * Imepangwa kulingana na mstari wa kwanza ambao zinaonekana.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * Kitambulisho cha mtu huyo.
     */
    id: string;

    /**
     * Jina la mtu huyo.
     */
    name: string;

    /**
     * Kama jina la mtu huyo ni jina sahihi.
     */
    isProperName?: boolean;

    /**
     * Jinsia ya mtu huyo.
     */
    gender?: string;

    /**
     * Mwaka ambao mtu huyo alizaliwa na mwaka ambao alikufa.
     * Nambari hasi ni miaka BC. Nambari chanya ni miaka AD.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Kiungo cha API cha mtu huyo.
     */
    apiLink: string;

    /**
     * Idadi ya mistari katika sura inayomtaja mtu huyo.
     * Imepangwa kwa mpangilio wa kupanda.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * Kitambulisho cha mahali hapo.
     */
    id: string;

    /**
     * Jina la mahali hapo.
     */
    name: string;

    /**
     * Aina ya sifa ya kijiografia ambayo mahali hapo ni.
     */
    featureType?: string;

    /**
     * Latitudo na longitudo ya mahali hapo.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Kiungo cha API cha mahali hapo.
     */
    apiLink: string;

    /**
     * Idadi ya mistari katika sura inayotaja mahali hapo.
     * Imepangwa kwa mpangilio wa kupanda.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * Kitambulisho cha tukio hilo.
     */
    id: string;

    /**
     * Jina la tukio.
     */
    name: string;

    /**
     * Tarehe ambayo tukio lilianza.
     */
    startDate?: string;

    /**
     * Kiungo cha API cha tukio hilo.
     */
    apiLink: string;

    /**
     * Idadi ya mistari katika sura inayoelezea tukio hilo.
     * Imepangwa kwa mpangilio wa kupanda.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * Taarifa za seti ya data kwa ajili ya watu.
     */
    dataset: Dataset;

    /**
     * Orodha ya watu wanaopatikana kwa ajili ya seti ya data.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * Kitambulisho cha mtu huyo.
     */
    id: string;

    /**
     * Jina la mtu huyo.
     */
    name: string;

    /**
     * Kama jina la mtu huyo ni jina sahihi.
     */
    isProperName?: boolean;

    /**
     * Jinsia ya mtu huyo.
     */
    gender?: string;

    /**
     * Idadi ya marejeleo ya Biblia yanayomtaja mtu huyo.
     */
    numberOfReferences: number;

    /**
     * Kiungo cha API cha mtu huyo.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * Taarifa ya seti ya data kwa mtu huyo.
     */
    dataset: Dataset;

    /**
     * Taarifa kuhusu mtu huyo.
     */
    person: DatasetPerson;

    /**
     * Kiungo cha API cha mtu huyu.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * Kitambulisho cha mtu huyo.
     */
    id: string;

    /**
     * Jina la mtu huyo.
     */
    name: string;

    /**
     * Majina mengine ambayo mtu huyo anaitwa.
     */
    alsoCalled?: string[];

    /**
     * Kama jina la mtu huyo ni jina sahihi.
     */
    isProperName?: boolean;

    /**
     * Jinsia ya mtu huyo.
     */
    gender?: string;

    /**
     * Maelezo ya mtu. Kila mfuatano ni aya.
     */
    description?: string[];

    /**
     * Mwaka ambao mtu huyo alizaliwa na mwaka ambao alikufa.
     * Nambari hasi ni miaka BC. Nambari chanya ni miaka AD.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Miaka ya mwanzo na ya mwisho ambayo mtu huyo anatajwa.
     */
    minYear?: number;
    maxYear?: number;

    /**
     * Mahali ambapo mtu huyo alizaliwa na kufia.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * Mahusiano ya kifamilia ya mtu huyo.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * Makundi ya watu ambayo mtu huyo ni mwanachama wake.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * Matukio ambayo mtu huyo alishiriki.
     */
    events?: DatasetEntityRef[];

    /**
     * Orodha ya marejeleo ya Biblia yanayomtaja mtu huyo.
     * Imepangwa kwa mpangilio wa kitabu, sura, na mstari.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * Taarifa ya seti ya data kwa maeneo hayo.
     */
    dataset: Dataset;

    /**
     * Orodha ya maeneo yanayopatikana kwa seti ya data.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * Kitambulisho cha mahali hapo.
     */
    id: string;

    /**
     * Jina la mahali hapo.
     */
    name: string;

    /**
     * Aina ya sifa ya kijiografia ambayo mahali hapo ni.
     * Kwa mfano, "Mji", "Mkoa", "Mlima", "Maji", n.k.
     */
    featureType?: string;

    /**
     * Latitudo na longitudo ya mahali hapo.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Idadi ya marejeleo ya Biblia yanayotaja mahali hapo.
     */
    numberOfReferences: number;

    /**
     * Kiungo cha API cha mahali hapo.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * Taarifa ya seti ya data ya mahali hapo.
     */
    dataset: Dataset;

    /**
     * Taarifa kuhusu mahali hapo.
     */
    place: DatasetPlace;

    /**
     * Kiungo cha API cha mahali hapa.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * Kitambulisho cha mahali hapo.
     */
    id: string;

    /**
     * Jina la mahali hapo.
     */
    name: string;

    /**
     * Jina la mahali hapo kama linavyoonekana katika Toleo la King James na Toleo la Kiingereza la Standard.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * Majina mengine ambayo mahali hapo panaitwa.
     */
    aliases?: string[];

    /**
     * Aina ya sifa ya kijiografia ambayo mahali hapo ni.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * Latitudo na longitudo za mahali hapo, na jinsi zilivyo sahihi.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * Maelezo ya mahali. Kila mfuatano ni aya.
     */
    description?: string[];

    /**
     * Maoni kuhusu eneo hilo kutoka kwa waandishi wa seti ya data.
     */
    comment?: string;

    /**
     * Mahali pa msingi pa mahali hapa.
     * Majina tofauti ya eneo moja la kijiografia yana sehemu moja ya mzizi.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * Mahali ambapo mahali hapa ni nakala yake.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * Watu waliokuwepo, waliozaliwa, au waliokufa mahali hapo.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * Matukio yaliyotokea mahali hapo.
     */
    events?: DatasetEntityRef[];

    /**
     * Orodha ya marejeleo ya Biblia yanayotaja mahali hapo.
     * Imepangwa kwa mpangilio wa kitabu, sura, na mstari.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * Taarifa za seti ya data kwa ajili ya matukio.
     */
    dataset: Dataset;

    /**
     * Orodha ya matukio yanayopatikana kwa ajili ya seti ya data.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * Kitambulisho cha tukio hilo.
     */
    id: string;

    /**
     * Jina la tukio.
     */
    name: string;

    /**
     * Tarehe ambayo tukio lilianza.
     * Nambari hasi ni miaka BC. Nambari chanya ni miaka AD.
     * Tarehe maalum zaidi hutumia umbizo `YYYY-MM-DD` .
     */
    startDate?: string;

    /**
     * Idadi ya marejeleo ya Biblia yanayoelezea tukio hilo.
     */
    numberOfReferences: number;

    /**
     * Kiungo cha API cha tukio hilo.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * Taarifa za seti ya data kwa ajili ya tukio hilo.
     */
    dataset: Dataset;

    /**
     * Taarifa kuhusu tukio hilo.
     */
    event: DatasetEvent;

    /**
     * Kiungo cha API cha tukio hili.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * Kitambulisho cha tukio hilo.
     */
    id: string;

    /**
     * Jina la tukio.
     */
    name: string;

    /**
     * Tarehe ambayo tukio lilianza.
     */
    startDate?: string;

    /**
     * Muda wa tukio.
     * Kwa mfano, "1D" ni siku moja na "40Y" ni miaka arobaini.
     */
    duration?: string;

    /**
     * Watu walioshiriki katika tukio hilo.
     */
    participants?: DatasetEntityRef[];

    /**
     * Maeneo ambayo tukio hilo lilitokea.
     */
    locations?: DatasetEntityRef[];

    /**
     * Makundi ya watu walioshiriki katika tukio hilo.
     */
    groups?: DatasetEntityRef[];

    /**
     * Tukio ambalo tukio hili ni sehemu yake.
     */
    partOf?: DatasetEntityRef;

    /**
     * Tukio lililotokea kabla ya tukio hili.
     */
    predecessor?: DatasetEntityRef;

    /**
     * Orodha ya marejeleo ya Biblia yanayoelezea tukio hilo.
     * Imepangwa kwa mpangilio wa kitabu, sura, na mstari.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * Taarifa za seti ya data kwa makundi ya watu.
     */
    dataset: Dataset;

    /**
     * Orodha ya makundi ya watu yanayopatikana kwa ajili ya seti ya data.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * Kitambulisho cha kundi la watu.
     */
    id: string;

    /**
     * Jina la kundi la watu.
     */
    name: string;

    /**
     * Idadi ya watu ambao ni wanachama wa kundi la watu.
     */
    numberOfMembers: number;

    /**
     * Kiungo cha API cha kundi la watu.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * Taarifa ya seti ya data kwa ajili ya kundi la watu.
     */
    dataset: Dataset;

    /**
     * Taarifa kuhusu kundi la watu.
     */
    group: DatasetPeopleGroup;

    /**
     * Kiungo cha API cha kundi hili la watu.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * Kitambulisho cha kundi la watu.
     */
    id: string;

    /**
     * Jina la kundi la watu.
     */
    name: string;

    /**
     * Watu ambao ni wanachama wa kundi la watu.
     */
    members?: DatasetEntityRef[];

    /**
     * Matukio ambayo kundi la watu lilishiriki.
     */
    events?: DatasetEntityRef[];

    /**
     * Orodha ya marejeleo ya Biblia yanayotaja kundi la watu.
     * Imepangwa kwa mpangilio wa kitabu, sura, na mstari.
     */
    references: VerseRef[];
}