@tricoteuses/assemblee/lib/loaders.d.ts

Retrieve, clean up & handle French Assemblée nationale's open data

import { Datasets, EnabledDatasets, Dataset } from './datasets.js';
import { ActeurClean as Acteur, OrganeClean as Organe, PhotoClean as Photo } from './schemas/clean/acteurs_et_organes.js';
import { ReunionClean as Reunion } from './schemas/clean/agendas.js';
import { AmendementClean as Amendement } from './schemas/clean/amendements.js';
import { CompteRenduClean as CompteRendu } from './schemas/clean/debats.js';
import { DocumentClean as Document, DossierParlementaireClean as DossierParlementaire } from './schemas/clean/dossiers_legislatifs.js';
import { Legislature } from './legislatures';
import { ScrutinClean as Scrutin } from './schemas/clean/scrutins.js';
import { QuestionClean as Question } from './schemas/clean/questions.js';
import { DocumentUrlFormat } from './urls.js';
export { EnabledDatasets } from './datasets.js';
export { walkDir } from './file_systems.js';
export interface Data {
    readonly acteurByUid: {
        [uid: string]: Acteur;
    };
    readonly amendementByUid: {
        [uid: string]: Amendement;
    };
    readonly documentByUid: {
        [uid: string]: Document;
    };
    readonly dossierParlementaireBySenatChemin: {
        [uid: string]: DossierParlementaire;
    };
    readonly dossierParlementaireByTitreChemin: {
        [uid: string]: DossierParlementaire;
    };
    readonly dossierParlementaireByUid: {
        [uid: string]: DossierParlementaire;
    };
    readonly organeByUid: {
        [uid: string]: Organe;
    };
    readonly photoByUid: {
        [uid: string]: Photo;
    };
    readonly reunionByUid: {
        [uid: string]: Reunion;
    };
    readonly reunionsByDay: {
        [day: string]: Reunion[];
    };
    readonly reunionsByDossierUid: {
        [dossierUid: string]: Reunion[];
    };
    readonly scrutinByUid: {
        [uid: string]: Scrutin;
    };
    readonly questionByUid: {
        [uid: string]: Question;
    };
    readonly compteRenduByUid: {
        [uid: string]: CompteRendu;
    };
}
export declare const datasets: Datasets;
export declare function iterLoadAssembleeActeurs(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    acteur: Acteur;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function iterLoadAssembleeOrganes(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    organe: Organe;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function iterLoadAssembleeAmendements(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    amendement: Amendement;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function iterLoadAssembleeDocuments(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    document: Document;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function iterLoadAssembleeDossiersParlementaires(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    dossierParlementaire: DossierParlementaire;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function iterLoadAssembleeReunions(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    reunion: Reunion;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function iterLoadAssembleeScrutins(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    scrutin: Scrutin;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function iterLoadAssembleeQuestions(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    question: Question;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function iterLoadAssembleeComptesRendus(dataDir: string, legislature: Legislature, options?: {}, customDatasets?: Dataset[]): Generator<{
    compteRendu: CompteRendu;
    datasetLegislature: Legislature;
    filePath: string;
    gitStatus?: "A" | "M" | "D" | "R" | "C" | "T" | "U";
}, void, unknown>;
export declare function loadAssembleeData(dataDir: string, enabledDatasets: EnabledDatasets, legislature: Legislature, { log }?: {
    log?: boolean | undefined;
}): Data;
export declare function loadAssembleeDataFromBigFiles(dataDir: string, enabledDatasets: EnabledDatasets, legislature: Legislature, { log }?: {
    log?: boolean | undefined;
}): Data;
/**
 * Read infos of a document or a division of a document from file system
 *
 * @param dataDir
 * @param uid UID of a document or a division
 * @param formats requested formats of the document in decreasing preference order
 */
export declare function loadAssembleeDocumentFile(dataDir: string, uid: string, formats: DocumentUrlFormat[]): {
    format: DocumentUrlFormat;
    path: string;
    url: string;
} | undefined;
export declare function loadAssembleePhotosDeputes(dataDir: string, legislature: Legislature, { log }?: {
    log?: boolean | undefined;
}): {
    [uid: string]: Photo;
};
export declare function loadAssembleePhotosSenateurs(dataDir: string, { log }?: {
    log?: boolean | undefined;
}): {
    [uid: string]: Photo;
};
export declare function pathFromDocumentUid(documentsDir: string, uid: string): string;
export declare function pathFromDossierParlementaireUid(dossiersDir: string, uid: string): string;
export declare function pathFromReunionUid(reunionsDir: string, uid: string): string;
export declare function pathFromScrutinUid(scrutinsDir: string, uid: string): string;
export declare function pathFromQuestionUid(dataDir: string, uid: string): string;
export declare function pathFromCompteRenduUid(dataDir: string, uid: string): string;