UNPKG

@tricoteuses/assemblee

Version:

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

127 lines (126 loc) 5.18 kB
export { EnabledDatasets } from "./datasets"; import { EnabledDatasets } from "./datasets"; export { walkDir } from "./file_systems"; import { Acteur, Organe, Photo } from "./types/acteurs_et_organes"; import { Reunion } from "./types/agendas"; import { Amendement } from "./types/amendements"; import { Document, DossierParlementaire } from "./types/dossiers_legislatifs"; import { Legislature } from "./types/legislatures"; import { Scrutin } from "./types/scrutins"; import { Question } from "./types/questions"; import { CompteRendu } from "./types/debats"; import { DocumentUrlFormat } from "./urls"; 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 function iterLoadAssembleeActeurs(dataDir: string, legislature: Legislature, options?: {}): Generator<{ acteur: Acteur; datasetLegislature: Legislature; }, void, unknown>; export declare function iterLoadAssembleeOrganes(dataDir: string, legislature: Legislature, options?: {}): Generator<{ organe: Organe; datasetLegislature: Legislature; }, void, unknown>; export declare function iterLoadAssembleeAmendements(dataDir: string, legislature: Legislature, options?: {}): Generator<{ amendement: Amendement; datasetLegislature: Legislature; }, void, unknown>; export declare function iterLoadAssembleeDocuments(dataDir: string, legislature: Legislature, options?: {}): Generator<{ document: Document; datasetLegislature: Legislature; }, void, unknown>; export declare function iterLoadAssembleeDossiersParlementaires(dataDir: string, legislature: Legislature, options?: {}): Generator<{ dossierParlementaire: DossierParlementaire; datasetLegislature: Legislature; }, void, unknown>; export declare function iterLoadAssembleeReunions(dataDir: string, legislature: Legislature, options?: {}): Generator<{ reunion: Reunion; datasetLegislature: Legislature; }, void, unknown>; export declare function iterLoadAssembleeScrutins(dataDir: string, legislature: Legislature, options?: {}): Generator<{ scrutin: Scrutin; datasetLegislature: Legislature; }, void, unknown>; export declare function iterLoadAssembleeQuestions(dataDir: string, legislature: Legislature, options?: {}): Generator<{ question: Question; datasetLegislature: Legislature; }, void, unknown>; export declare function iterLoadAssembleeComptesRendus(dataDir: string, legislature: Legislature, options?: {}): Generator<{ compteRendu: CompteRendu; datasetLegislature: Legislature; }, 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;