Datastelle

export interface AvailableDatasets {
    /**
     * Die lys van datastelle.
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * Die ID van die datastel.
     */
    id: string;

    /**
     * Die naam van die datastel.
     */
    name: string;

    /**
     * Die webwerf vir die datastel.
     */
    website: string;

    /**
     * Die URL waar die lisensie vir die datastel gevind kan word.
     */
    licenseUrl: string;

    /**
     * Die Engelse naam vir die datastel.
     */
    englishName: string;

    /**
     * Die ISO 639 3-letter taaletiket waarin die datastel hoofsaaklik is.
     */
    language: string;

    /**
     * Die rigting waarin die taal geskryf is.
     * "ltr" dui aan dat die teks van die linkerkant van die bladsy na regs geskryf is.
     * "rtl" dui aan dat die teks van die regterkant van die bladsy na links geskryf is.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * Die API-skakel vir die lys van beskikbare boeke vir hierdie datastel.
     */
    listOfBooksApiLink: string;

    /**
     * Die beskikbare lys van formate.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * Die aantal boeke wat in hierdie datastel voorkom.
     */
    numberOfBooks: number;

    /**
     * Die totale aantal hoofstukke wat in hierdie datastel voorkom.
     */
    totalNumberOfChapters: number;

    /**
     * Die totale aantal verse wat in hierdie datastel vervat is.
     */
    totalNumberOfVerses: number;

    /**
     * Die totale aantal kruisverwysings wat in hierdie datastel voorkom.
     */
    totalNumberOfReferences: number;

    /**
     * Kry die naam van die taal waarin die datastel is.
     * Nul of ongedefinieerd indien die naam van die taal nie bekend is nie.
     */
    languageName?: string;

    /**
     * Kry die naam van die taal in Engels.
     * Nul of ongedefinieerd as die taal nie 'n Engelse naam het nie.
     */
    languageEnglishName?: string;

    /**
     * Die API-skakels vir die lyste van entiteite in die datastel.
     * Weglaat as die datastel nie die ooreenstemmende entiteite bevat nie.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * Die totale aantal entiteite wat in die datastel voorkom.
     * Weglaat as die datastel nie die ooreenstemmende entiteite bevat nie.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * Die datastelinligting vir die boeke.
     */
    dataset: Dataset;

    /**
     * Die lys van boeke wat beskikbaar is vir die datastel.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * Die ID van die boek.
     * Stem ooreen met die ID van die ooreenstemmende boek in die Bybel (GEN, EXO, ens.).
     */
    id: string;

    /**
     * Die volgorde van die boek in die Bybel.
     */
    order: number;

    /**
     * Die nommer van die eerste hoofstuk in die boek.
     */
    firstChapterNumber: number;

    /**
     * Die skakel na die eerste hoofstuk van die boek.
     */
    firstChapterApiLink: string | null;

    /**
     * Die nommer van die laaste hoofstuk in die boek.
     */
    lastChapterNumber: number | null;

    /**
     * Die skakel na die laaste hoofstuk van die boek.
     */
    lastChapterApiLink: string | null;

    /**
     * Die aantal hoofstukke wat die boek bevat.
     */
    numberOfChapters: number;

    /**
     * Die aantal verse wat die boek bevat.
     */
    totalNumberOfVerses: number;

    /**
     * Die totale aantal kruisverwysings wat hierdie boek bevat.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * Die datastelinligting vir die boekhoofstuk.
     */
    dataset: Dataset;

    /**
     * Die boekinligting vir die boekhoofstuk.
     */
    book: DatasetBook;

    /**
     * Die skakel na hierdie hoofstuk.
     */
    thisChapterLink: string;

    /**
     * Die skakel na die volgende hoofstuk.
     * Nul as dit die laaste hoofstuk in die datastel is.
     */
    nextChapterApiLink: string | null;

    /**
     * Die skakel na die vorige hoofstuk.
     * Nul as dit die eerste hoofstuk in die datastel is.
     */
    previousChapterApiLink: string | null;

    /**
     * Die aantal verse wat die hoofstuk bevat.
     */
    numberOfVerses: number;

    /**
     * Die inligting vir die hoofstuk.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * Die nommer van die hoofstuk.
     */
    number: number;

    /**
     * Die inhoud van die hoofstuk.
     */
    content: DatasetVerse[];
}

interface DatasetVerse {
    /**
     * Die nommer van die vers.
     */
    verse: number;

    /**
     * Die kruisverwysings vir die vers.
     *
     * Gesorteer volgens telling, aflopend.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * Die ID van die boek waarna verwys word.
     */
    book: string;

    /**
     * Die hoofstuknommer.
     */
    chapter: number;

    /**
     * Die versnommer.
     * As `endVerse` teenwoordig is, dan is dit die vers waar die verwysing begin.
     */
    verse: number;

    /**
     * Die vers waar die verwysing eindig.
     */
    endVerse?: number;

    /**
     * Die relevansietelling vir die verwysing.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * Die ID van die entiteit waarna verwys word.
     */
    id: string;

    /**
     * Die tipe entiteit waarna verwys word.
     * Stem ooreen met die versamelingsegment van die entiteit se API-skakel, sodat die skakel as `/api/d/{dataset}/{type}/{id}.json` gekonstrueer kan word.
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * Die naam van die entiteit waarna verwys word.
     */
    name?: string;

    /**
     * Die API-skakel vir die entiteit waarna verwys word.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * Die ID van die boek (GEN, EXO, ens.).
     */
    book: string;

    /**
     * Die hoofstuknommer waarmee die verwysing begin.
     */
    chapter: number;

    /**
     * Die versnommer waarmee die verwysing begin.
     */
    verse: number;

    /**
     * Die vers waar die verwysing eindig.
     * Opeenvolgende verse in dieselfde hoofstuk word in 'n enkele verwysing saamgevoeg.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * Die datastelinligting vir die boekhoofstuk.
     */
    dataset: Dataset;

    /**
     * Die boekinligting vir die boekhoofstuk.
     */
    book: DatasetBook;

    /**
     * Die entiteitsdata vir die hoofstuk.
     */
    chapter: DatasetEntityChapterData;

    /**
     * Die skakel na hierdie hoofstuk.
     */
    thisChapterLink: string;

    /**
     * Die skakel na die volgende hoofstuk.
     * Nul as dit die laaste hoofstuk in die datastel is.
     */
    nextChapterApiLink: string | null;

    /**
     * Die skakel na die vorige hoofstuk.
     * Nul as dit die eerste hoofstuk in die datastel is.
     */
    previousChapterApiLink: string | null;

    /**
     * Die aantal mense, plekke en gebeurtenisse wat in die hoofstuk verskyn.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * Die nommer van die hoofstuk.
     */
    number: number;

    /**
     * Die mense wat in die hoofstuk verskyn.
     * Gesorteer volgens die eerste vers waarin hulle verskyn.
     */
    people: ChapterPerson[];

    /**
     * Die plekke wat in die hoofstuk verskyn.
     * Gesorteer volgens die eerste vers waarin hulle verskyn.
     */
    places: ChapterPlace[];

    /**
     * Die gebeure wat in die hoofstuk voorkom.
     * Gesorteer volgens die eerste vers waarin hulle verskyn.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * Die persoon se ID.
     */
    id: string;

    /**
     * Die naam van die persoon.
     */
    name: string;

    /**
     * Of die persoon se naam 'n eienaam is.
     */
    isProperName?: boolean;

    /**
     * Die geslag van die persoon.
     */
    gender?: string;

    /**
     * Die jaar waarin die persoon gebore is en die jaar waarin hulle gesterf het.
     * Negatiewe getalle is jare v.C. Positiewe getalle is jare n.C.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Die API-skakel vir die persoon.
     */
    apiLink: string;

    /**
     * Die nommers van die verse in die hoofstuk wat die persoon noem.
     * Gesorteer in stygende volgorde.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * Die ID van die plek.
     */
    id: string;

    /**
     * Die naam van die plek.
     */
    name: string;

    /**
     * Die tipe geografiese kenmerk wat die plek is.
     */
    featureType?: string;

    /**
     * Die breedtegraad en lengtegraad van die plek.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Die API-skakel vir die plek.
     */
    apiLink: string;

    /**
     * Die nommers van die verse in die hoofstuk wat die plek noem.
     * Gesorteer in stygende volgorde.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * Die ID van die gebeurtenis.
     */
    id: string;

    /**
     * Die naam van die geleentheid.
     */
    name: string;

    /**
     * Die datum waarop die geleentheid begin het.
     */
    startDate?: string;

    /**
     * Die API-skakel vir die geleentheid.
     */
    apiLink: string;

    /**
     * Die nommers van die verse in die hoofstuk wat die gebeurtenis beskryf.
     * Gesorteer in stygende volgorde.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * Die datastelinligting vir die mense.
     */
    dataset: Dataset;

    /**
     * Die lys van mense wat beskikbaar is vir die datastel.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * Die persoon se ID.
     */
    id: string;

    /**
     * Die naam van die persoon.
     */
    name: string;

    /**
     * Of die persoon se naam 'n eienaam is.
     */
    isProperName?: boolean;

    /**
     * Die geslag van die persoon.
     */
    gender?: string;

    /**
     * Die aantal Bybelverwysings wat die persoon noem.
     */
    numberOfReferences: number;

    /**
     * Die API-skakel vir die persoon.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * Die datastelinligting vir die persoon.
     */
    dataset: Dataset;

    /**
     * Die inligting oor die persoon.
     */
    person: DatasetPerson;

    /**
     * Die API-skakel vir hierdie persoon.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * Die persoon se ID.
     */
    id: string;

    /**
     * Die naam van die persoon.
     */
    name: string;

    /**
     * Ander name waarmee die persoon genoem word.
     */
    alsoCalled?: string[];

    /**
     * Of die persoon se naam 'n eienaam is.
     */
    isProperName?: boolean;

    /**
     * Die geslag van die persoon.
     */
    gender?: string;

    /**
     * Die beskrywing van die persoon. Elke string is 'n paragraaf.
     */
    description?: string[];

    /**
     * Die jaar waarin die persoon gebore is en die jaar waarin hulle gesterf het.
     * Negatiewe getalle is jare v.C. Positiewe getalle is jare n.C.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Die vroegste en jongste jare waarin die persoon genoem word.
     */
    minYear?: number;
    maxYear?: number;

    /**
     * Die plek waar die persoon gebore is en gesterf het.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * Die persoon se familieverhoudings.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * Die mensegroepe waarvan die persoon 'n lid is.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * Die gebeure waaraan die persoon deelgeneem het.
     */
    events?: DatasetEntityRef[];

    /**
     * Die lys van Bybelverwysings wat die persoon noem.
     * Gesorteer volgens boekvolgorde, hoofstuk en vers.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * Die datastelinligting vir die plekke.
     */
    dataset: Dataset;

    /**
     * Die lys van plekke wat beskikbaar is vir die datastel.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * Die ID van die plek.
     */
    id: string;

    /**
     * Die naam van die plek.
     */
    name: string;

    /**
     * Die tipe geografiese kenmerk wat die plek is.
     * Byvoorbeeld, "Stad", "Streek", "Berg", "Water", ens.
     */
    featureType?: string;

    /**
     * Die breedtegraad en lengtegraad van die plek.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Die aantal Bybelverwysings wat die plek noem.
     */
    numberOfReferences: number;

    /**
     * Die API-skakel vir die plek.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * Die datastelinligting vir die plek.
     */
    dataset: Dataset;

    /**
     * Die inligting oor die plek.
     */
    place: DatasetPlace;

    /**
     * Die API-skakel vir hierdie plek.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * Die ID van die plek.
     */
    id: string;

    /**
     * Die naam van die plek.
     */
    name: string;

    /**
     * Die naam van die plek soos dit in die King James-weergawe en die English Standard Version verskyn.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * Ander name waarmee die plek genoem word.
     */
    aliases?: string[];

    /**
     * Die tipe geografiese kenmerk wat die plek is.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * Die breedtegraad en lengtegraad van die plek, en hoe presies hulle is.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * Die beskrywing van die plek. Elke string is 'n paragraaf.
     */
    description?: string[];

    /**
     * Die kommentaar oor die plek van die outeurs van die datastel.
     */
    comment?: string;

    /**
     * Die wortelplek vir hierdie plek.
     * Verskillende name vir dieselfde geografiese ligging deel dieselfde stamplek.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * Die plek waarvan hierdie plek 'n duplikaat is.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * Die mense wat op die plek was, daar gebore is, of daar gesterf het.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * Die gebeure wat op die plek plaasgevind het.
     */
    events?: DatasetEntityRef[];

    /**
     * Die lys van Bybelverwysings wat die plek noem.
     * Gesorteer volgens boekvolgorde, hoofstuk en vers.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * Die datastelinligting vir die gebeurtenisse.
     */
    dataset: Dataset;

    /**
     * Die lys van gebeurtenisse wat beskikbaar is vir die datastel.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * Die ID van die gebeurtenis.
     */
    id: string;

    /**
     * Die naam van die geleentheid.
     */
    name: string;

    /**
     * Die datum waarop die geleentheid begin het.
     * Negatiewe getalle is jare v.C. Positiewe getalle is jare n.C.
     * Meer spesifieke datums gebruik die `YYYY-MM-DD` formaat.
     */
    startDate?: string;

    /**
     * Die aantal Bybelverwysings wat die gebeurtenis beskryf.
     */
    numberOfReferences: number;

    /**
     * Die API-skakel vir die geleentheid.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * Die datastelinligting vir die gebeurtenis.
     */
    dataset: Dataset;

    /**
     * Die inligting oor die geleentheid.
     */
    event: DatasetEvent;

    /**
     * Die API-skakel vir hierdie gebeurtenis.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * Die ID van die gebeurtenis.
     */
    id: string;

    /**
     * Die naam van die geleentheid.
     */
    name: string;

    /**
     * Die datum waarop die geleentheid begin het.
     */
    startDate?: string;

    /**
     * Die duur van die gebeurtenis.
     * Byvoorbeeld, "1D" is een dag en "40Y" is veertig jaar.
     */
    duration?: string;

    /**
     * Die mense wat aan die geleentheid deelgeneem het.
     */
    participants?: DatasetEntityRef[];

    /**
     * Die plekke waar die gebeurtenis plaasgevind het.
     */
    locations?: DatasetEntityRef[];

    /**
     * Die mensegroepe wat aan die geleentheid deelgeneem het.
     */
    groups?: DatasetEntityRef[];

    /**
     * Die gebeurtenis waarvan hierdie gebeurtenis deel is.
     */
    partOf?: DatasetEntityRef;

    /**
     * Die gebeurtenis wat voor hierdie gebeurtenis plaasgevind het.
     */
    predecessor?: DatasetEntityRef;

    /**
     * Die lys van Bybelverwysings wat die gebeurtenis beskryf.
     * Gesorteer volgens boekvolgorde, hoofstuk en vers.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * Die datastelinligting vir die mensegroepe.
     */
    dataset: Dataset;

    /**
     * Die lys van mensegroepe wat beskikbaar is vir die datastel.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * Die ID van die mensegroep.
     */
    id: string;

    /**
     * Die naam van die mensegroep.
     */
    name: string;

    /**
     * Die aantal mense wat lede van die mensegroep is.
     */
    numberOfMembers: number;

    /**
     * Die API-skakel vir die mensegroep.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * Die datastelinligting vir die mensegroep.
     */
    dataset: Dataset;

    /**
     * Die inligting oor die mensegroep.
     */
    group: DatasetPeopleGroup;

    /**
     * Die API-skakel vir hierdie mensegroep.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * Die ID van die mensegroep.
     */
    id: string;

    /**
     * Die naam van die mensegroep.
     */
    name: string;

    /**
     * Die mense wat lede van die mensegroep is.
     */
    members?: DatasetEntityRef[];

    /**
     * Die gebeure waaraan die mensegroep deelgeneem het.
     */
    events?: DatasetEntityRef[];

    /**
     * Die lys van Bybelverwysings wat die mensegroep noem.
     * Gesorteer volgens boekvolgorde, hoofstuk en vers.
     */
    references: VerseRef[];
}