@geo2france/api-dashboard 1.19.0 → 1.20.0

package/dist/components/Charts/ChartComparison.d.ts

@@ -1,9 +1,9 @@
 import { EChartsOption } from "echarts";
-import { useDatasetInput } from "../Dataset/hooks";
+import { datasetInput } from "../Dataset/hooks";
 type labelType = "percent" | "value" | "category" | "none";
 export interface ChartComparisonProps {
     /** Identifiant du dataset */
-    dataset?: useDatasetInput;
+    dataset?: datasetInput;
     /** Nom de la colonne qui contient les valeurs numériques */
     valueKey: string;
     /** Nom de la colonne qui contient les catégories */

package/dist/components/Charts/Datatable.d.ts

@@ -0,0 +1,14 @@
+import { datasetInput } from "../Dataset/hooks";
+export interface DataTableProps {
+    /** Jeu de données */
+    dataset: datasetInput;
+    /** Titre du composant */
+    title?: string;
+    /** Nombre d'éléments par page */
+    pageSize?: number;
+    /** Style CSS du tableau */
+    style?: React.CSSProperties;
+}
+/** Afficher un dataset sous forme de tableau
+ */
+export declare const DataTable: React.FC<DataTableProps>;

package/dist/components/Charts/Datatable.js

@@ -0,0 +1,22 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Table } from "antd";
+import { useDataset } from "../Dataset/hooks";
+import { useBlockConfig } from "../DashboardPage/Block";
+/** Afficher un dataset sous forme de tableau
+ */
+export const DataTable = ({ dataset: dataset_id, title, pageSize = 5, style }) => {
+    const dataset = useDataset(dataset_id); //Récupérer le jeu de données
+    const data = dataset?.data;
+    useBlockConfig({
+        title: title,
+        dataExport: data
+    });
+    const cols = Object.keys(data?.[0] || {})?.map((k) => ({
+        dataIndex: k,
+        title: k,
+        ellipsis: true,
+        key: k,
+        render: (v) => typeof v === 'number' ? isNaN(v) ? '' : v.toLocaleString() : v,
+    }));
+    return _jsx(Table, { columns: cols, style: style, className: "data-table", dataSource: Array.isArray(data) ? data?.map((r, idx) => ({ ...r, key: idx })) : [], pagination: { pageSize: pageSize } });
+};

package/dist/components/Charts/Pie.d.ts

@@ -1,9 +1,9 @@
-import { useDatasetInput } from "../Dataset/hooks";
+import { datasetInput } from "../Dataset/hooks";
 import { EChartsOption, LabelFormatterCallback } from "echarts";
 import type { CallbackDataParams } from 'echarts/types/dist/shared';
 export interface IChartPieProps {
     /** Identifiant du dataset */
-    dataset?: useDatasetInput;
+    dataset?: datasetInput;
     /** Nom de la colonne qui contient les valeurs numériques */
     dataKey: string;
     /** Nom de la colonne qui contient les catégories */

package/dist/components/Charts/Statistics.d.ts

@@ -1,5 +1,5 @@
 import { ReactElement } from "react";
-import { useDatasetInput } from "../Dataset/hooks";
+import { datasetInput } from "../Dataset/hooks";
 import { SimpleRecord } from "../../types";
 type comparwithType = "first" | "previous";
 type aggregateType = "last" | "first" | "sum" | "lastNotNull" | "min" | "max" | "count" | "mean" | "countDistinct" | "countMissing";
@@ -15,7 +15,7 @@ interface ICallbackParams {
 }
 export interface StatisticsProps {
     /** Identifiant du jeu de données ou tableau de valeurs */
-    dataset: useDatasetInput;
+    dataset: datasetInput;
     /** Nom de la colonne qui contient les valeurs */
     dataKey: string;
     /** Texte à afficher après l'évolution */

package/dist/components/Charts/YearSerie.d.ts

@@ -1,10 +1,10 @@
 /**
  * Graphique standard pour afficher des données annuelles
  */
-import { useDatasetInput } from "../Dataset/hooks";
+import { datasetInput } from "../Dataset/hooks";
 import { EChartsOption, SeriesOption } from "echarts";
 export interface IYearSerieProps {
-    dataset: useDatasetInput;
+    dataset: datasetInput;
     title?: string;
     yearKey: string;
     valueKey: string;

package/dist/components/Control/Select.d.ts

@@ -1,17 +1,29 @@
 import type { SelectProps } from 'antd';
 type ExtendedSelectProps = Omit<SelectProps<any>, 'options'> & {
+    /** Nom technique du controle */
+    name?: string;
+    /** Nom à afficher */
+    label?: string;
+    /** Jeu de données contenant les choix (à la place de options) */
     dataset?: string;
+    /** Choix possible */
     options?: {
         label: string;
         value: string;
     }[] | string[];
+    /** Valeur intiale sélectionnée */
     initial_value?: string;
+    /** Colonne à utiliser pour le libellé (si dataset utilisé) */
     labelField?: string;
+    /** Colonne à utiliser pour la valeur (si dataset utilisé) */
     valueField?: string;
-    name?: string;
-    label?: string;
+    /** Affichage des flèches Suivant/Précédent */
     arrows?: boolean;
+    /** Inverser le sens des flêches */
     reverse?: boolean;
 };
+/** Composant de controle permettant de choisir une valeur parmis une liste de choix.
+ * Adapté pour les choix de territoires ou d'années
+ */
 export declare const Select: React.FC<ExtendedSelectProps>;
 export {};

package/dist/components/Control/Select.js

@@ -5,6 +5,9 @@ import NextPrevSelect from '../NextPrevSelect/NextPrevSelect';
 import { list_to_options } from './Control';
 // TODO : a fusionner avec NextPrevSelect pour n'avoir qu'un seul composant
 // Actuellement, Select apporte seulement le fait de choisir les valeurs depuis un
+/** Composant de controle permettant de choisir une valeur parmis une liste de choix.
+ * Adapté pour les choix de territoires ou d'années
+ */
 export const Select = ({ name, dataset: datasetSource, options: input_options = [], labelField = 'label', valueField = 'value', arrows = false, reverse = false, label, initial_value: initial_value_in, ...rest }) => {
     const options = list_to_options(input_options);
     const data = useDataset(datasetSource)?.data;

package/dist/components/Dataset/Dataset.d.ts

@@ -1,17 +1,26 @@
 import { ReactNode } from "react";
 import { SimpleRecord } from "../..";
-import { CrudFilters, DataProvider } from "../../data_providers/types";
+import { CrudFilters } from "../../data_providers/types";
 import React from "react";
 import { ProviderType } from "./Provider";
 interface IDatasetProps {
+    /**Identifiant interne unique du jeu de données*/
     id: string;
-    provider?: DataProvider;
+    /** Url du fournisseur */
     url?: string;
-    type?: ProviderType;
+    /** Type de fournisseur */
+    type: ProviderType;
+    /** Nom de la ressource côté fournisseur
+     * (couche, dataset, fichier, etc.)
+     */
     resource: string;
+    /**
+     * ⚠️ deprecated
+     */
     filters?: CrudFilters;
     children?: ReactNode;
     pageSize?: number;
+    /** Paramètres additionnels à passer au fournisseur */
     meta?: any;
 }
 export type dataset = {
@@ -24,5 +33,8 @@ export type dataset = {
     geojson?: any;
     dataHash?: number;
 };
+/**
+ * Composant **logique** permettant de récupérer des données.
+ */
 export declare const DSL_Dataset: React.FC<IDatasetProps>;
 export {};

package/dist/components/Dataset/Dataset.js

@@ -3,14 +3,17 @@ import { useContext, useEffect } from "react";
 import { useApi } from "../..";
 import { Producer } from "./Producer";
 import React from "react";
-import { Filter, Transform, useAllControls, useAllDatasets, useDatasets } from "../../dsl";
+import { Filter, Transform, useAllDatasets, useDatasets } from "../../dsl";
 import alasql from "alasql";
 import { DataProviderContext, getProviderFromType } from "./Provider";
 import { Join } from "./Join";
 import { from } from "arquero";
 import hashCode from "../../utils/hash_data";
 import { DatasetRegistryContext } from "./context";
-export const DSL_Dataset = ({ children, id, provider: provider_input, type: providerType = 'file', url: providerUrl, resource, pageSize, meta }) => {
+/**
+ * Composant **logique** permettant de récupérer des données.
+ */
+export const DSL_Dataset = ({ children, id, type: providerType, url: providerUrl, resource, pageSize, meta }) => {
     const getTransformerFn = (component) => {
         /*
         * Génére une fonction transformer soit
@@ -57,18 +60,17 @@ export const DSL_Dataset = ({ children, id, provider: provider_input, type: prov
     };
     const datasetRegistryContext = useContext(DatasetRegistryContext);
     const allDatasets = useAllDatasets();
-    const controls = useAllControls();
     const providerContext = useContext(DataProviderContext);
-    const provider = (providerUrl && getProviderFromType(providerType)(providerUrl)) || providerContext || provider_input;
+    const provider = (providerUrl && getProviderFromType(providerType)(providerUrl)) || providerContext;
     if (provider === undefined) {
-        throw new Error("Error : No dataProvider, please use one of : <Provider> parent, providerUrl/providerType properties or provider property");
+        throw new Error("Error : No dataProvider, please use providerUrl/providerType properties");
     }
     /* Récupérer les props des filtres depuis les composants enfant Filter */
     const filters = [];
     React.Children.toArray(children)
         .filter((c) => React.isValidElement(c))
         .filter((c) => typeof c.type != 'string' && c.type.name == Filter.name).forEach((c) => {
-        const value = (typeof c.props.children === "string" ? c.props.children.trim() : c.props.children) || controls?.[c.props.control];
+        const value = (typeof c.props.children === "string" ? c.props.children.trim() : c.props.children);
         filters.push({
             operator: c.props.operator || 'eq',
             value: value,

package/dist/components/Dataset/Filter.d.ts

@@ -2,7 +2,6 @@ import { CrudOperators } from "../../data_providers/types";
 interface IFilterProps {
     field: string;
     children?: string | string[];
-    control?: string;
     operator?: Exclude<CrudOperators, "or" | "and">;
 }
 export declare const DSL_Filter: React.FC<IFilterProps>;

package/dist/components/Dataset/hooks.d.ts

@@ -1,7 +1,7 @@
 import { dataset } from "./Dataset";
 import { SimpleRecord } from "../..";
-export type useDatasetInput = string | SimpleRecord[];
-export declare const useDataset: (dataset_id?: useDatasetInput) => dataset | undefined;
+export type datasetInput = string | SimpleRecord[];
+export declare const useDataset: (dataset_id?: datasetInput) => dataset | undefined;
 export declare const useAllDatasets: () => dataset[];
 export declare const useDatasets: (dataset_ids?: string[]) => dataset[];
 /**

package/dist/dsl/index.d.ts

@@ -23,4 +23,5 @@ import { Section } from "../components/DashboardPage/Section";
 import { LegendControl } from "../components/MapLegend/MapLegend";
 import { Intro } from "../components/DashboardPage/Intro";
 import { ChartComparison } from "../components/Charts/ChartComparison";
-export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, ChartComparison, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };
+import { DataTable } from "../components/Charts/Datatable";
+export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, ChartComparison, DataTable, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };

package/dist/dsl/index.js

@@ -23,4 +23,5 @@ import { Section } from "../components/DashboardPage/Section";
 import { LegendControl } from "../components/MapLegend/MapLegend";
 import { Intro } from "../components/DashboardPage/Intro";
 import { ChartComparison } from "../components/Charts/ChartComparison";
-export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, ChartComparison, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };
+import { DataTable } from "../components/Charts/Datatable";
+export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, ChartComparison, DataTable, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };

package/dist/index.d.ts

@@ -28,5 +28,6 @@ export { WfsProvider, DatafairProvider, FileProvider };
 export type { SimpleRecord, Partner, RouteConfig } from "./types";
 export type { LegendItem } from "./components/MapLegend/MapLegend";
 export type { DashboardConfig } from "./components/Layout/DashboardApp";
+export type { datasetInput } from "./components/Dataset/hooks";
 import * as DSL from './dsl';
 export { DSL };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geo2france/api-dashboard",
-  "version": "1.19.0",
+  "version": "1.20.0",
   "private": false,
   "description": "Build dashboards with JSX/TSX",
   "main": "dist/index.js",