@tricoteuses/assemblee/lib/scripts/retrieve_open_data.d.ts

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

import { Dataset } from '../datasets.js';
type ProcessDatasetArguments = {
    dataset: Dataset;
    dataDir: string;
    options: Options;
};
declare const retrieveOpenDataParser: import('zod-opts').Parser<{
    fetch: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    categories: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodArray<import('zod').ZodString>>;
    };
    legislature: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodArray<import('zod').ZodNumber>>;
    };
    silent: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    verbose: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    "only-recent": {
        description: string;
        type: import('zod').ZodOptional<import('zod').ZodNumber>;
    };
    skipReindent: {
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    keepDir: {
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    clone: {
        alias: string;
        description: string;
        type: import('zod').ZodOptional<import('zod').ZodString>;
    };
    commit: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    remote: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodArray<import('zod').ZodString>>;
    };
    pull: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    fetchDocuments: {
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    parseDocuments: {
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    format: {
        alias: string;
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodArray<import('zod').ZodString>>;
    };
    fetchVideos: {
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
    fetchCrCommissions: {
        description: string;
        type: import('zod').ZodDefault<import('zod').ZodBoolean>;
    };
}, [{
    description: string;
    type: import('zod').ZodString;
    name: "dataDir";
}]>;
type Options = ReturnType<typeof retrieveOpenDataParser.parse>;
/**
 * Processes a dataset by fetching, unzipping, and converting files from XML to JSON format.
 *
 * @param {any} dataset - The dataset object containing metadata and processing instructions.
 * @param {string} dataDir - The directory where the dataset files will be stored.
 * @param {any} options - Options to control the processing behavior, such as fetching and silent mode.
 * @returns {Promise<void>} A promise that resolves when the dataset processing is complete.
 */
export declare function processDataset({ dataset, dataDir, options: { fetch, silent, skipReindent }, }: ProcessDatasetArguments): Promise<void>;
export {};