Ensembles de données

export interface AvailableDatasets {
    /**
     * La liste des ensembles de données.
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * L'identifiant du jeu de données.
     */
    id: string;

    /**
     * Le nom de l'ensemble de données.
     */
    name: string;

    /**
     * Le site web contenant l'ensemble de données.
     */
    website: string;

    /**
     * L'URL où se trouve la licence du jeu de données.
     */
    licenseUrl: string;

    /**
     * Le nom anglais de l'ensemble de données.
     */
    englishName: string;

    /**
     * L'étiquette de langue à 3 lettres ISO 639 dans laquelle se trouve principalement l'ensemble de données.
     */
    language: string;

    /**
     * Le sens dans lequel la langue est écrite.
     * « ltr » indique que le texte est écrit de gauche à droite sur la page.
     * « rtl » indique que le texte est écrit de la droite vers la gauche.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * Lien API vers la liste des livres disponibles pour cet ensemble de données.
     */
    listOfBooksApiLink: string;

    /**
     * Liste des formats disponibles.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * Le nombre de livres contenus dans cet ensemble de données.
     */
    numberOfBooks: number;

    /**
     * Le nombre total de chapitres contenus dans cet ensemble de données.
     */
    totalNumberOfChapters: number;

    /**
     * Le nombre total de versets contenus dans cet ensemble de données.
     */
    totalNumberOfVerses: number;

    /**
     * Le nombre total de références croisées contenues dans cet ensemble de données.
     */
    totalNumberOfReferences: number;

    /**
     * Obtient le nom de la langue dans laquelle se trouve l'ensemble de données.
     * Valeur nulle ou indéfinie si le nom de la langue est inconnu.
     */
    languageName?: string;

    /**
     * Obtient le nom de la langue en anglais.
     * Valeur nulle ou indéfinie si la langue n'a pas de nom en anglais.
     */
    languageEnglishName?: string;

    /**
     * Les liens API pour les listes d'entités dans l'ensemble de données.
     * Omis si l'ensemble de données ne contient pas les entités correspondantes.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * Le nombre total d'entités contenues dans l'ensemble de données.
     * Omis si l'ensemble de données ne contient pas les entités correspondantes.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * Informations sur les données relatives aux livres.
     */
    dataset: Dataset;

    /**
     * Liste des livres disponibles pour l'ensemble de données.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * L'identifiant du livre.
     * Correspond à l'identifiant du livre correspondant dans la Bible (GENÈVE, EXO, etc.).
     */
    id: string;

    /**
     * L'ordre des livres dans la Bible.
     */
    order: number;

    /**
     * Le numéro du premier chapitre du livre.
     */
    firstChapterNumber: number;

    /**
     * Le lien vers le premier chapitre du livre.
     */
    firstChapterApiLink: string | null;

    /**
     * Le numéro du dernier chapitre du livre.
     */
    lastChapterNumber: number | null;

    /**
     * Le lien vers le dernier chapitre du livre.
     */
    lastChapterApiLink: string | null;

    /**
     * Le nombre de chapitres que contient le livre.
     */
    numberOfChapters: number;

    /**
     * Le nombre de versets que contient le livre.
     */
    totalNumberOfVerses: number;

    /**
     * Le nombre total de références croisées que contient ce livre.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * Informations sur l'ensemble de données pour ce chapitre du livre.
     */
    dataset: Dataset;

    /**
     * Informations relatives au chapitre du livre.
     */
    book: DatasetBook;

    /**
     * Le lien vers ce chapitre.
     */
    thisChapterLink: string;

    /**
     * Le lien vers le chapitre suivant.
     * Nul si c'est le dernier chapitre de l'ensemble de données.
     */
    nextChapterApiLink: string | null;

    /**
     * Le lien vers le chapitre précédent.
     * Nul s'il s'agit du premier chapitre de l'ensemble de données.
     */
    previousChapterApiLink: string | null;

    /**
     * Le nombre de versets que contient le chapitre.
     */
    numberOfVerses: number;

    /**
     * Informations relatives à ce chapitre.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * Le numéro du chapitre.
     */
    number: number;

    /**
     * Le contenu du chapitre.
     */
    content: DatasetVerse[];
}

interface DatasetVerse {
    /**
     * Le numéro du verset.
     */
    verse: number;

    /**
     * Les références croisées pour le verset.
     *
     * Trié par score, décroissant.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * L'identifiant du livre auquel il est fait référence.
     */
    book: string;

    /**
     * Le numéro du chapitre.
     */
    chapter: number;

    /**
     * Le numéro du verset.
     * Si la valeur `endVerse` est présente, alors il s'agit du verset à partir duquel la référence commence.
     */
    verse: number;

    /**
     * Le verset auquel se termine la référence.
     */
    endVerse?: number;

    /**
     * Score de pertinence de la référence.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * L'identifiant de l'entité référencée.
     */
    id: string;

    /**
     * Le type de l'entité référencée.
     * Correspond au segment de collection du lien API de l'entité, de sorte que le lien peut être construit comme `/api/d/{dataset}/{type}/{id}.json` .
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * Le nom de l'entité à laquelle il est fait référence.
     */
    name?: string;

    /**
     * Lien API de l'entité référencée.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * L'identifiant du livre (GEN, EXO, etc.).
     */
    book: string;

    /**
     * Le numéro du chapitre à partir duquel la référence commence.
     */
    chapter: number;

    /**
     * Le numéro du verset à partir duquel la référence commence.
     */
    verse: number;

    /**
     * Le verset auquel se termine la référence.
     * Les versets consécutifs d'un même chapitre sont regroupés en une seule référence.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * Informations sur l'ensemble de données pour ce chapitre du livre.
     */
    dataset: Dataset;

    /**
     * Informations relatives au chapitre du livre.
     */
    book: DatasetBook;

    /**
     * Les données d'entité pour le chapitre.
     */
    chapter: DatasetEntityChapterData;

    /**
     * Le lien vers ce chapitre.
     */
    thisChapterLink: string;

    /**
     * Le lien vers le chapitre suivant.
     * Nul si c'est le dernier chapitre de l'ensemble de données.
     */
    nextChapterApiLink: string | null;

    /**
     * Le lien vers le chapitre précédent.
     * Nul s'il s'agit du premier chapitre de l'ensemble de données.
     */
    previousChapterApiLink: string | null;

    /**
     * Le nombre de personnes, de lieux et d'événements qui apparaissent dans le chapitre.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * Le numéro du chapitre.
     */
    number: number;

    /**
     * Les personnes qui apparaissent dans ce chapitre.
     * Classés selon le premier verset dans lequel ils apparaissent.
     */
    people: ChapterPerson[];

    /**
     * Les lieux qui apparaissent dans le chapitre.
     * Classés selon le premier verset dans lequel ils apparaissent.
     */
    places: ChapterPlace[];

    /**
     * Les événements qui apparaissent dans ce chapitre.
     * Classés selon le premier verset dans lequel ils apparaissent.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * L'identité de la personne.
     */
    id: string;

    /**
     * Le nom de la personne.
     */
    name: string;

    /**
     * Si le nom de la personne est un nom propre.
     */
    isProperName?: boolean;

    /**
     * Le sexe de la personne.
     */
    gender?: string;

    /**
     * L'année de naissance et l'année de décès de la personne.
     * Les nombres négatifs correspondent aux années avant J.-C. Les nombres positifs correspondent aux années après J.-C.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Lien API de la personne.
     */
    apiLink: string;

    /**
     * Les numéros des versets du chapitre qui mentionnent la personne.
     * Trié par ordre croissant.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * L'identifiant du lieu.
     */
    id: string;

    /**
     * Le nom du lieu.
     */
    name: string;

    /**
     * Le type de caractéristique géographique du lieu.
     */
    featureType?: string;

    /**
     * La latitude et la longitude du lieu.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Lien API pour ce lieu.
     */
    apiLink: string;

    /**
     * Les numéros des versets du chapitre qui mentionnent le lieu.
     * Trié par ordre croissant.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * L'identifiant de l'événement.
     */
    id: string;

    /**
     * Le nom de l'événement.
     */
    name: string;

    /**
     * La date à laquelle l'événement a débuté.
     */
    startDate?: string;

    /**
     * Lien API pour l'événement.
     */
    apiLink: string;

    /**
     * Les numéros des versets du chapitre qui décrivent l'événement.
     * Trié par ordre croissant.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * Les données relatives aux personnes.
     */
    dataset: Dataset;

    /**
     * Liste des personnes disponibles pour l'ensemble de données.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * L'identité de la personne.
     */
    id: string;

    /**
     * Le nom de la personne.
     */
    name: string;

    /**
     * Si le nom de la personne est un nom propre.
     */
    isProperName?: boolean;

    /**
     * Le sexe de la personne.
     */
    gender?: string;

    /**
     * Le nombre de références bibliques mentionnant cette personne.
     */
    numberOfReferences: number;

    /**
     * Lien API de la personne.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * Informations relatives à la personne dans l'ensemble de données.
     */
    dataset: Dataset;

    /**
     * Les informations concernant la personne.
     */
    person: DatasetPerson;

    /**
     * Lien API pour cette personne.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * L'identité de la personne.
     */
    id: string;

    /**
     * Le nom de la personne.
     */
    name: string;

    /**
     * Autres noms par lesquels la personne est appelée.
     */
    alsoCalled?: string[];

    /**
     * Si le nom de la personne est un nom propre.
     */
    isProperName?: boolean;

    /**
     * Le sexe de la personne.
     */
    gender?: string;

    /**
     * Description de la personne. Chaque chaîne de caractères correspond à un paragraphe.
     */
    description?: string[];

    /**
     * L'année de naissance et l'année de décès de la personne.
     * Les nombres négatifs correspondent aux années avant J.-C. Les nombres positifs correspondent aux années après J.-C.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Les années les plus anciennes et les plus récentes où la personne est mentionnée.
     */
    minYear?: number;
    maxYear?: number;

    /**
     * Le lieu de naissance et de décès de la personne.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * Les relations familiales de la personne.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * Les groupes ethniques auxquels la personne appartient.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * Les événements auxquels la personne a participé.
     */
    events?: DatasetEntityRef[];

    /**
     * La liste des références bibliques mentionnant cette personne.
     * Triés par ordre de livre, chapitre et verset.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * Informations sur les données relatives aux lieux.
     */
    dataset: Dataset;

    /**
     * Liste des lieux disponibles pour l'ensemble de données.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * L'identifiant du lieu.
     */
    id: string;

    /**
     * Le nom du lieu.
     */
    name: string;

    /**
     * Le type de caractéristique géographique du lieu.
     * Par exemple, « Ville », « Région », « Montagne », « Eau », etc.
     */
    featureType?: string;

    /**
     * La latitude et la longitude du lieu.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Le nombre de références bibliques mentionnant ce lieu.
     */
    numberOfReferences: number;

    /**
     * Lien API pour ce lieu.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * Informations relatives aux données de ce lieu.
     */
    dataset: Dataset;

    /**
     * Les informations concernant le lieu.
     */
    place: DatasetPlace;

    /**
     * Lien API pour cet endroit.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * L'identifiant du lieu.
     */
    id: string;

    /**
     * Le nom du lieu.
     */
    name: string;

    /**
     * Le nom du lieu tel qu'il apparaît dans la version du roi Jacques et la version standard anglaise.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * Autres noms donnés à ce lieu.
     */
    aliases?: string[];

    /**
     * Le type de caractéristique géographique du lieu.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * La latitude et la longitude du lieu, et leur précision.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * Description du lieu. Chaque chaîne de caractères correspond à un paragraphe.
     */
    description?: string[];

    /**
     * Commentaire des auteurs du jeu de données concernant ce lieu.
     */
    comment?: string;

    /**
     * Le lieu d'origine de cet endroit.
     * Différents noms pour un même lieu géographique partagent la même origine.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * L'endroit dont cet endroit est une copie conforme.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * Les personnes qui ont séjourné à cet endroit, y sont nées ou y sont décédées.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * Les événements qui se sont déroulés à cet endroit.
     */
    events?: DatasetEntityRef[];

    /**
     * Liste des références bibliques mentionnant ce lieu.
     * Triés par ordre de livre, chapitre et verset.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * Informations relatives aux événements dans l'ensemble de données.
     */
    dataset: Dataset;

    /**
     * Liste des événements disponibles pour l'ensemble de données.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * L'identifiant de l'événement.
     */
    id: string;

    /**
     * Le nom de l'événement.
     */
    name: string;

    /**
     * La date à laquelle l'événement a débuté.
     * Les nombres négatifs correspondent aux années avant J.-C. Les nombres positifs correspondent aux années après J.-C.
     * Les dates plus précises utilisent le format `YYYY-MM-DD` .
     */
    startDate?: string;

    /**
     * Le nombre de références bibliques qui décrivent l'événement.
     */
    numberOfReferences: number;

    /**
     * Lien API pour l'événement.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * Informations relatives aux données de l'événement.
     */
    dataset: Dataset;

    /**
     * Informations concernant l'événement.
     */
    event: DatasetEvent;

    /**
     * Lien API pour cet événement.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * L'identifiant de l'événement.
     */
    id: string;

    /**
     * Le nom de l'événement.
     */
    name: string;

    /**
     * La date à laquelle l'événement a débuté.
     */
    startDate?: string;

    /**
     * La durée de l'événement.
     * Par exemple, « 1J » signifie un jour et « 40Y » quarante ans.
     */
    duration?: string;

    /**
     * Les personnes qui ont participé à l'événement.
     */
    participants?: DatasetEntityRef[];

    /**
     * Les lieux où l'événement s'est déroulé.
     */
    locations?: DatasetEntityRef[];

    /**
     * Les groupes ethniques qui ont participé à l'événement.
     */
    groups?: DatasetEntityRef[];

    /**
     * L'événement dont cet événement fait partie.
     */
    partOf?: DatasetEntityRef;

    /**
     * L'événement qui s'est produit avant cet événement.
     */
    predecessor?: DatasetEntityRef;

    /**
     * Liste des références bibliques décrivant l'événement.
     * Triés par ordre de livre, chapitre et verset.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * Informations sur les groupes de population.
     */
    dataset: Dataset;

    /**
     * Liste des groupes ethniques disponibles pour l'ensemble de données.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * L'identifiant du groupe ethnique.
     */
    id: string;

    /**
     * Le nom du groupe ethnique.
     */
    name: string;

    /**
     * Le nombre de personnes qui font partie du groupe ethnique.
     */
    numberOfMembers: number;

    /**
     * Lien API pour le groupe de personnes.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * Informations relatives aux données du groupe de personnes.
     */
    dataset: Dataset;

    /**
     * Les informations concernant ce groupe ethnique.
     */
    group: DatasetPeopleGroup;

    /**
     * Lien API pour ce groupe de personnes.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * L'identifiant du groupe ethnique.
     */
    id: string;

    /**
     * Le nom du groupe ethnique.
     */
    name: string;

    /**
     * Les personnes qui appartiennent au groupe ethnique.
     */
    members?: DatasetEntityRef[];

    /**
     * Les événements auxquels ce groupe ethnique a participé.
     */
    events?: DatasetEntityRef[];

    /**
     * Liste des références bibliques mentionnant ce peuple.
     * Triés par ordre de livre, chapitre et verset.
     */
    references: VerseRef[];
}