@geo2france/api-dashboard 1.11.1 → 1.12.0

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

@@ -1,11 +1,13 @@
 import { ReactElement } from "react";
 import { SimpleRecord } from "../../types";
 type comparwithType = "first" | "previous";
-interface annotation_params_type {
+interface ICallbackParams {
     /** Valeur principale */
     value: number;
     /** Jeu de données utilisé */
     data: SimpleRecord[] | undefined;
+    /** Ligne courante (pour accéder aux autres champs) */
+    row: SimpleRecord | undefined;
     /** Valeur de comparaison */
     compareValue: number;
 }
@@ -33,7 +35,9 @@ interface StatisticsProps {
     /** Comparer la valeur avec la précédente ou la première du jeu de données */
     compareWith?: comparwithType;
     /** Texte d'annotation (remplace evolution si définie) */
-    annotation?: React.ReactNode | ((param: annotation_params_type) => React.ReactNode);
+    annotation?: React.ReactNode | ((param: ICallbackParams) => React.ReactNode);
+    /** Fonction a appliquer avant rendu */
+    valueFormatter?: ((param: ICallbackParams) => React.ReactNode);
 }
 /**
  * Composant `Statistics` affichant une valeur d'un dataset avec son évolution.

package/dist/components/Charts/Statistics.js

@@ -20,19 +20,20 @@ const { Text, Paragraph } = Typography;
  * @param {StatisticsProps} props - Propriétés du composant
  * @returns {ReactElement} Carte statistique
  */
-export const Statistics = ({ dataset: dataset_id, dataKey, unit, evolutionSuffix, title, icon: icon_input, color, invertColor = false, help, compareWith, relativeEvolution = false, annotation }) => {
+export const Statistics = ({ dataset: dataset_id, dataKey, unit, evolutionSuffix, title, icon: icon_input, color, invertColor = false, help, compareWith, relativeEvolution = false, valueFormatter = (param) => (param.value.toLocaleString()), annotation }) => {
     const icon = typeof icon_input === "string" ? _jsx(Icon, { icon: icon_input }) : icon_input;
     const dataset = useDataset(dataset_id);
-    const value = dataset?.data?.slice(-1)[0][dataKey]; // Dernière valeur du dataset. Caster en Number ?
+    const row = dataset?.data?.slice(-1)[0];
+    const value = row?.[dataKey]; // Dernière valeur du dataset. Caster en Number ?
     const compare_value = compareWith === 'previous' ? dataset?.data?.slice(-2)[0][dataKey] : dataset?.data?.slice(0, 1)[0][dataKey]; //Première ou avant dernière
     const evolution = relativeEvolution ? 100 * ((value - compare_value) / compare_value) : value - compare_value;
     const evolution_unit = relativeEvolution ? '%' : unit;
     const evolution_is_good = invertColor ? evolution < 0 : evolution > 0;
     const tooltip = help && _jsx(Tooltip, { title: help, children: _jsx(QuestionCircleOutlined, {}) });
-    const annotation_params = { value: value || NaN, compareValue: compare_value || NaN, data: dataset?.data || [] };
+    const CallbackParams = { value: value || NaN, compareValue: compare_value || NaN, data: dataset?.data || [], row: row };
     let subtitle;
     if (annotation !== undefined) {
-        subtitle = typeof annotation === 'function' ? annotation(annotation_params) : annotation;
+        subtitle = typeof annotation === 'function' ? annotation(CallbackParams) : annotation;
     }
     else if (evolution) {
         subtitle = (_jsxs(Paragraph, { style: { marginBottom: "0.5rem" }, children: [_jsxs(Text, { strong: true, type: evolution_is_good ? "success" : "danger", style: { fontSize: "120%" }, children: [evolution < 0.1 ? '' : '+', evolution.toLocaleString(undefined, { maximumFractionDigits: 1 }), "\u00A0", evolution_unit] }), " ", _jsx(Text, { italic: true, type: "secondary", children: evolutionSuffix })] }));
@@ -52,7 +53,7 @@ export const Statistics = ({ dataset: dataset_id, dataKey, unit, evolutionSuffix
                 fontSize: 14,
                 minHeight: 35,
             },
-        }, extra: tooltip, children: _jsxs(Flex, { vertical: true, children: [_jsxs(Flex, { justify: "space-between", align: "center", children: [_jsxs(Text, { style: { fontSize: "150%", paddingTop: 8, paddingBottom: 8, paddingLeft: 0 }, children: [value?.toLocaleString(), " ", unit] }), icon && _jsx(Avatar, { size: 32 + 8, icon: icon, style: { backgroundColor: color } })] }), typeof subtitle == 'string' ?
+        }, extra: tooltip, children: _jsxs(Flex, { vertical: true, children: [_jsxs(Flex, { justify: "space-between", align: "center", children: [_jsxs(Text, { style: { fontSize: "150%", paddingTop: 8, paddingBottom: 8, paddingLeft: 0 }, children: [valueFormatter(CallbackParams), " ", unit] }), icon && _jsx(Avatar, { size: 32 + 8, icon: icon, style: { backgroundColor: color } })] }), typeof subtitle == 'string' ?
                     _jsx(Text, { italic: true, type: "secondary", children: subtitle })
                     :
                         _jsx("div", { children: subtitle })] }) }));

package/dist/components/DashboardPage/Page.d.ts

@@ -25,6 +25,7 @@ type dataset = {
     isError: boolean;
     producers?: any[];
     geojson?: any;
+    dataHash?: number;
 };
 type ControlContextType = {
     values: Record<string, any>;

package/dist/components/Dataset/Dataset.js

@@ -4,11 +4,12 @@ import { useApi } from "../..";
 import { ControlContext, DatasetRegistryContext } from "../DashboardPage/Page";
 import { Producer } from "./Producer";
 import React from "react";
-import { Filter, Transform, useAllDatasets } 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";
 export const DSL_Dataset = ({ children, id, provider: provider_input, type: providerType = 'file', url: providerUrl, resource, pageSize, meta }) => {
     const getTransformerFn = (component) => {
         /*
@@ -37,9 +38,16 @@ export const DSL_Dataset = ({ children, id, provider: provider_input, type: prov
                     inner: { left: false, right: false },
                 }[join_type] ?? { left: false, right: false };
                 const otherData = allDatasets?.find((d) => d.id === props.dataset)?.data;
-                if (!otherData || otherData.length < 1)
+                // Return undefinied if otherData is Fetching ?
+                if (!otherData || !data)
                     return undefined; // prevent arquero from crash on missed data
-                return from(data).join(from(otherData), props.joinKey, undefined, aq_join_option).objects();
+                //fallback if one of dataset is empty. Build a 1 row table with existing joinKey
+                const [leftKey, rightKey] = Array.isArray(props.joinKey) // joinKey can be a string or un string[]
+                    ? props.joinKey
+                    : [props.joinKey, props.joinKey];
+                const leftTable = data.length >= 1 ? data : [{ [leftKey]: null }];
+                const rightTable = otherData.length >= 1 ? otherData : [{ [rightKey]: null }];
+                return from(leftTable).join(from(rightTable), props.joinKey, undefined, aq_join_option).objects();
             };
             return funct;
         }
@@ -49,7 +57,6 @@ export const DSL_Dataset = ({ children, id, provider: provider_input, type: prov
     };
     const datasetRegistryContext = useContext(DatasetRegistryContext);
     const allDatasets = useAllDatasets();
-    const someFetching = !!allDatasets?.some(d => d.isFetching);
     const controlContext = useContext(ControlContext);
     const controls = controlContext?.values;
     const providerContext = useContext(DataProviderContext);
@@ -70,12 +77,15 @@ export const DSL_Dataset = ({ children, id, provider: provider_input, type: prov
         });
     });
     const { data, isFetching, isError } = useApi({ dataProvider: provider, resource: resource, filters: filters, pagination: { pageSize: pageSize }, meta: meta });
+    const dep_dataset_id = []; // Dependencies
     const transformers = [];
     /* Récuperer les fonctions transformers */
     React.Children.toArray(children)
         .filter((c) => React.isValidElement(c))
         .filter((c) => typeof c.type != 'string' && (c.type.name == Transform.name || c.type.name == Join.name)).forEach((c) => {
         transformers.push(getTransformerFn(c));
+        if (typeof c.type != 'string' && c.type.name == Join.name)
+            dep_dataset_id.push(c.props.dataset); // Add joint dataset in dep list
     });
     const producers = [];
     React.Children.toArray(children)
@@ -83,12 +93,24 @@ export const DSL_Dataset = ({ children, id, provider: provider_input, type: prov
         .filter((c) => typeof c.type != 'string' && c.type.name == Producer.name).forEach((c) => {
         producers.push({ nom: c.props.children, url: c.props.url });
     });
+    const depDataset = useDatasets(dep_dataset_id);
+    const depDataHash = depDataset?.map(d => d?.dataHash); //Build hash array from data
+    const someDepsAreFetching = depDataset?.some(d => d?.isFetching);
     useEffect(() => {
         const finalData = data?.data && transformers.reduce((datat, fn) => fn(datat), data.data);
         if (datasetRegistryContext) {
-            datasetRegistryContext({ id: id, resource: resource, data: finalData, isFetching: isFetching, isError: isError, producers: producers, geojson: data?.geojson });
+            datasetRegistryContext({
+                id: id,
+                resource: resource,
+                data: finalData,
+                isFetching: !!isFetching || !!someDepsAreFetching,
+                isError: isError,
+                producers: producers,
+                geojson: data?.geojson,
+                dataHash: hashCode(finalData)
+            });
             //Ajouter une info pour distinguer les erreurs du fourniseurs et celles des transformers ?
         }
-    }, [resource, data, isFetching, someFetching, children]);
+    }, [resource, data, (!!isFetching || !!someDepsAreFetching), hashCode(depDataHash), children]);
     return (_jsx(_Fragment, { children: children }));
 };

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

@@ -6,6 +6,7 @@ export declare const useDataset: (dataset_id?: string) => {
     isError: boolean;
     producers?: any[];
     geojson?: any;
+    dataHash?: number;
 } | undefined;
 export declare const useDatasets: (dataset_ids?: string[]) => {
     id: string;
@@ -15,6 +16,7 @@ export declare const useDatasets: (dataset_ids?: string[]) => {
     isError: boolean;
     producers?: any[];
     geojson?: any;
+    dataHash?: number;
 }[] | undefined;
 export declare const useAllDatasets: () => {
     id: string;
@@ -24,4 +26,5 @@ export declare const useAllDatasets: () => {
     isError: boolean;
     producers?: any[];
     geojson?: any;
+    dataHash?: number;
 }[] | undefined;

package/dist/data_providers/wfs/utils/mapOperator.d.ts

@@ -0,0 +1 @@
+export declare const mapOperator: (operator: any) => string;

package/dist/data_providers/wfs/utils/mapOperator.js

@@ -0,0 +1,36 @@
+export const mapOperator = (operator) => {
+    switch (operator) {
+        case "ne":
+            return '<>';
+        case "gte":
+            return '>=';
+        case "gt":
+            return '>';
+        case "lte":
+            return `<=`;
+        case "lt":
+            return `<`;
+        case "eq":
+            return "=";
+        case "contains":
+        case "startswith":
+        case "endswith":
+            return "ilike";
+        case "containss":
+        case "startswiths":
+        case "endswiths":
+            return "like";
+        case "ncontains":
+        case "nstartswith":
+        case "nendswith":
+            return "not ilike";
+        case "ncontainss":
+        case "nstartswiths":
+        case "nendswiths":
+            return "not like";
+        case "in":
+            return operator;
+        default:
+            return "";
+    }
+};

package/dist/utils/hash_data.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns a hash code from a string
+ * From https://stackoverflow.com/a/8831937/10995624
+ * @param  {String} str The string to hash.
+ * @return {Number}    A 32bit integer
+ * @see http://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/
+ */
+declare function hashCode(input: any): number | undefined;
+export default hashCode;

package/dist/utils/hash_data.js

@@ -0,0 +1,20 @@
+/**
+ * Returns a hash code from a string
+ * From https://stackoverflow.com/a/8831937/10995624
+ * @param  {String} str The string to hash.
+ * @return {Number}    A 32bit integer
+ * @see http://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/
+ */
+function hashCode(input) {
+    if (input === undefined)
+        return undefined;
+    let hash = 0;
+    const str = JSON.stringify(input);
+    for (let i = 0, len = str.length; i < len; i++) {
+        let chr = str.charCodeAt(i);
+        hash = (hash << 5) - hash + chr;
+        hash |= 0; // Convert to 32bit integer
+    }
+    return hash;
+}
+export default hashCode;

package/dist/utils/useBlockConfig.d.ts

@@ -0,0 +1,7 @@
+import { SimpleRecord } from "../types";
+interface BlocConfig {
+    title?: string;
+    dataExport?: SimpleRecord[];
+}
+export declare const useBlockConfig: ({ title, dataExport }: BlocConfig) => void;
+export {};

package/dist/utils/useBlockConfig.js

@@ -0,0 +1,9 @@
+import { useContext, useEffect } from "react";
+import { ChartBlockContext } from "../components/DashboardPage/Block";
+export const useBlockConfig = ({ title, dataExport }) => {
+    const blockContext = useContext(ChartBlockContext);
+    useEffect(() => blockContext?.setConfig({
+        title: title,
+        dataExport: dataExport
+    }), [title, dataExport]);
+};

package/package.json

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