@devgateway/dvz-wp-commons 1.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2025 Development Gateway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/build/APIConfig.d.ts

@@ -0,0 +1,49 @@
+import React from "react";
+import { Component } from "@wordpress/element";
+import { Measure, Dimension, Filter, Category, Categories } from "./types";
+type APIConfigProps = {
+    allDimensions: Dimension[];
+    allFilters: Filter[];
+    allMeasures: Measure[];
+    allCategories: Categories;
+    setAttributes: (attributes: any) => void;
+    attributes: {
+        measures: Measure[];
+        filters: Filter[];
+        categories: Category[];
+        dimension1: string;
+        dimension2: string;
+        type: string;
+        swap: boolean;
+        manualColors: Record<string, Record<string, string>>;
+        scheme: string;
+        colorBy: string;
+        barColor: string;
+        app: string;
+        csv: string;
+        includeOverall: boolean;
+        types: any[];
+    };
+};
+export declare class APIConfig extends Component<APIConfigProps> {
+    constructor(props: APIConfigProps);
+    cleanSelection(prevState: any): void;
+    updateFilterParam(param: any, idx: any): void;
+    updateFilterValue(value: any, idx: any): void;
+    setFilterValue(value: any, idx: any): void;
+    addFilter(): void;
+    removeFilter(f: any): void;
+    componentDidUpdate(prevProps: any): void;
+    onSetSingleMeasure(value: any): void;
+    onFormatChange(format: any, field: any): void;
+    onUseCustomAxisFormatChange(value: any): void;
+    onMeasuresChange(value: string): void;
+    onCustomLabelToggleChange(value: string): void;
+    onCustomLabelChange(value: string, customLabel: string): void;
+    items(type: string): {
+        value: string;
+        id: number;
+    }[] | null;
+    render(): React.JSX.Element[];
+}
+export default APIConfig;

package/build/APIConfig.js

@@ -0,0 +1,302 @@
+import React from "react";
+import { Component } from "@wordpress/element";
+import { __ } from "@wordpress/i18n";
+import { Button, PanelBody, PanelRow, SelectControl, ToggleControl, } from "@wordpress/components";
+import Measures from "./Measures";
+const defaultFormat = {
+    style: "percent",
+    minimumFractionDigits: 1,
+    maximumFractionDigits: 1,
+    currency: "USD",
+};
+const FilterSelector = ({ param, index, options, onUpdateFilterParam }) => {
+    const sortedOptions = options.sort(function (a, b) {
+        var aLabel = a.label ? a.label.toLowerCase() : "";
+        var bLabel = b.label ? b.label.toLowerCase() : "";
+        return aLabel < bLabel ? -1 : aLabel > bLabel ? 1 : 0;
+    });
+    return (React.createElement(SelectControl, { onChange: (value) => {
+            onUpdateFilterParam(value, index);
+        }, value: param, options: sortedOptions }));
+};
+const CategoricalFilter = ({ value, index, items, onUpdateFilterValue }) => {
+    if (items) {
+        const sortedItems = items.sort(function (a, b) {
+            if (a.position !== undefined && b.position !== undefined) {
+                return a.position - b.position;
+            }
+            let aValue = a.value ? a.value.toLowerCase() : "";
+            let bValue = b.value ? b.value.toLowerCase() : "";
+            return aValue < bValue ? -1 : aValue > bValue ? 1 : 0;
+        });
+        return sortedItems.map((v) => (React.createElement(PanelRow, null,
+            " ",
+            React.createElement(ToggleControl, { label: v.value, checked: value.indexOf(v.id) > -1, onChange: (e) => {
+                    onUpdateFilterValue(v.id, index);
+                } }))));
+    }
+    else {
+        return null;
+    }
+};
+export class APIConfig extends Component {
+    constructor(props) {
+        super(props);
+        this.onMeasuresChange = this.onMeasuresChange.bind(this);
+        this.onSetSingleMeasure = this.onSetSingleMeasure.bind(this);
+        this.addFilter = this.addFilter.bind(this);
+        this.updateFilterParam = this.updateFilterParam.bind(this);
+        this.updateFilterValue = this.updateFilterValue.bind(this);
+        this.setFilterValue = this.setFilterValue.bind(this);
+        this.removeFilter = this.removeFilter.bind(this);
+        this.items = this.items.bind(this);
+        this.onFormatChange = this.onFormatChange.bind(this);
+        this.onCustomLabelToggleChange = this.onCustomLabelToggleChange.bind(this);
+        this.onCustomLabelChange = this.onCustomLabelChange.bind(this);
+        this.onUseCustomAxisFormatChange =
+            this.onUseCustomAxisFormatChange.bind(this);
+        //this.onCustomMeasureFieldChange = this.onCustomMeasureFieldChange.bind(this)
+        this.state = {
+            measures: [],
+            dimensions: [],
+            filters: [],
+            categories: [],
+        };
+    }
+    cleanSelection(prevState) {
+        const { setAttributes } = this.props;
+        setAttributes({ measures: [], filters: [] });
+    }
+    updateFilterParam(param, idx) {
+        const { attributes: { filters }, setAttributes, allFilters, } = this.props;
+        const newFilters = filters.slice();
+        const selected = allFilters.filter((f) => f.param === param)[0];
+        newFilters[idx] = { ...selected, value: [] };
+        setAttributes({ filters: newFilters });
+    }
+    updateFilterValue(value, idx) {
+        const { attributes: { filters }, setAttributes, allFilters, } = this.props;
+        const selected = filters[idx];
+        let values = selected.value;
+        if (values.indexOf(value) > -1) {
+            values = values.filter((v) => v != value);
+        }
+        else {
+            values.push(value);
+        }
+        const newFilters = filters.slice();
+        newFilters[idx].value = values;
+        setAttributes({ filters: newFilters });
+    }
+    setFilterValue(value, idx) {
+        const { attributes: { filters }, setAttributes, allFilters, } = this.props;
+        const selected = filters[idx];
+        let values = selected.value;
+        values = value.split(",");
+        const newFilters = filters.slice();
+        newFilters[idx].value = values;
+        setAttributes({ filters: newFilters });
+    }
+    addFilter() {
+        const { attributes: { filters }, setAttributes, allFilters, } = this.props;
+        let index = filters.length > allFilters.length ? allFilters.length : filters.length;
+        const newFilter = allFilters && allFilters.length > 0
+            ? {
+                ...allFilters[index],
+                value: [],
+            }
+            : null;
+        let newFilters = filters.slice();
+        newFilters.push(newFilter);
+        setAttributes({ filters: newFilters });
+    }
+    removeFilter(f) {
+        const { attributes: { filters }, setAttributes, allFilters, } = this.props;
+        let newFilters = filters.slice(0, -1);
+        setAttributes({ filters: newFilters });
+    }
+    componentDidUpdate(prevProps) {
+        const { setAttributes, attributes: { type, colorBy, dimension2, types, measures, app }, } = this.props;
+        const { attributes: { type: prevType, dimension2: prevDimension2 }, } = prevProps;
+        const prevTypeObject = types.filter((t) => t.value === prevType).length > 0
+            ? types.filter((t) => t.value === prevType)[0]
+            : null;
+        if (dimension2 != prevDimension2) {
+            //TODO ensure only one measure remains selected when selecting a second dimensions
+            const uMs = Object.assign({}, measures);
+            if (dimension2 != "none") {
+                let i = 0; //the idea is to keep one selected
+                if (uMs[app]) {
+                    const selected = Object.keys(uMs[app]).map((k) => uMs[app][k].selected).length;
+                    if (selected > 1) {
+                        Object.keys(uMs[app]).forEach((k) => {
+                            if (uMs[app][k].selected) {
+                                uMs[app][k].prevSelected = true; //can be used to recover measures
+                                uMs[app][k].selected = i > 0 ? false : true;
+                            }
+                            else {
+                                uMs[app][k].prevSelected = false;
+                            }
+                            i++;
+                        });
+                    }
+                }
+                setAttributes({ measures: uMs });
+            }
+            if (dimension2 == "none" && uMs[app]) {
+                Object.keys(uMs[app]).forEach((k) => {
+                    if (uMs[app][k].prevSelected) {
+                        uMs[app][k].selected = true; //can be used to recover measures
+                        uMs[app][k].prevSelected = false;
+                    }
+                });
+                setAttributes({ measures: uMs });
+            }
+        }
+    }
+    onSetSingleMeasure(value) {
+        const { setAttributes, attributes: { app, measures }, } = this.props;
+        const uMs = Object.assign({}, measures);
+        if (!uMs[app]) {
+            uMs[app] = {};
+        }
+        Object.keys(uMs[app])
+            .filter((k) => typeof uMs[app][k] !== "boolean")
+            .forEach((k) => (uMs[app][k].selected = false)); //single selection all other should be unselected
+        if (uMs[app][value]) {
+            uMs[app][value].selected = uMs[app][value].selected ? false : true;
+        }
+        else {
+            uMs[app][value] = { selected: true, format: defaultFormat };
+        }
+        setAttributes({ measures: uMs });
+    }
+    onFormatChange(format, field) {
+        const { setAttributes, attributes: { app, measures }, } = this.props;
+        const uMs = Object.assign({}, { ...measures });
+        if (!uMs[app]) {
+            uMs[app] = {
+                allowSelection: false,
+                format: format,
+                customFormat: format,
+                selected: false,
+            };
+        }
+        uMs[app][field] = format;
+        setAttributes({ measures: uMs });
+    }
+    onUseCustomAxisFormatChange(value) {
+        const { setAttributes, attributes: { app, measures }, } = this.props;
+        const uMs = Object.assign({}, { ...measures });
+        if (uMs[app]) {
+            uMs[app].useCustomAxisFormat = value;
+            setAttributes({ measures: uMs });
+        }
+        else {
+            uMs[app] = {
+                allowSelection: false,
+                format: defaultFormat,
+                customFormat: defaultFormat,
+                selected: false,
+                useCustomAxisFormat: value,
+            };
+            setAttributes({ measures: uMs });
+        }
+    }
+    /*
+      onCustomMeasureFieldChange(measureName, field, value) {
+  
+          const {setAttributes, attributes: {measures}} = this.props
+          const uMs = Object.assign({}, {...measures})
+  
+          if (uMs[measureName]) {
+              uMs[measureName][field] = value
+          } else {
+              uMs[measureName] = {allowSelection: false, field: value, selected: false}
+          }
+  
+          setAttributes({measures: uMs})
+      }
+      */
+    onMeasuresChange(value) {
+        const { setAttributes, attributes: { app, measures }, } = this.props;
+        const uMs = Object.assign({}, measures);
+        if (!uMs[app]) {
+            uMs[app] = {};
+        }
+        if (uMs[app][value]) {
+            uMs[app][value].selected = uMs[app][value].selected ? false : true;
+        }
+        else {
+            uMs[app][value] = { selected: true, format: defaultFormat };
+        }
+        setAttributes({ measures: uMs });
+    }
+    onCustomLabelToggleChange(value) {
+        const { setAttributes, attributes: { app, measures }, } = this.props;
+        const uMs = Object.assign({}, measures);
+        if (uMs[app] && uMs[app][value]) {
+            uMs[app][value].hasCustomLabel = uMs[app][value].hasCustomLabel
+                ? false
+                : true;
+            setAttributes({ measures: uMs });
+        }
+    }
+    onCustomLabelChange(value, customLabel) {
+        const { setAttributes, attributes: { app, measures }, } = this.props;
+        const uMs = Object.assign({}, measures);
+        if (uMs[app] && uMs[app][value] && uMs[app][value].hasCustomLabel) {
+            uMs[app][value].customLabel = customLabel;
+            setAttributes({ measures: uMs });
+        }
+    }
+    items(type) {
+        const values = this.props.allCategories
+            ? this.props.allCategories.filter((c) => c.type === type)
+            : [];
+        const cat = values.length > 0 ? values[0] : null;
+        let items = null;
+        if (type === "Boolean") {
+            items = [
+                { value: "Yes", id: 1 },
+                { value: "No", id: 0 },
+            ];
+        }
+        else if (cat) {
+            items = cat.items.map((item) => ({ value: item.value, id: item.id }));
+        }
+        return items;
+    }
+    render() {
+        const { allDimensions, allFilters, allMeasures, setAttributes, attributes: { measures, filters, dimension1, dimension2, type, types }, } = this.props;
+        const currentType = types.filter((t) => t.value === type).length > 0
+            ? types.filter((t) => t.value === type)[0]
+            : null;
+        return [
+            React.createElement(PanelBody, { initialOpen: false, title: __(type == "map" ? "Fields" : `Dimensions`) },
+                React.createElement(PanelRow, null,
+                    React.createElement(SelectControl, { multiple: false, label: __(type == "map" ? "Matching Field" : "First Dimension"), value: dimension1, onChange: (value) => {
+                            setAttributes({
+                                dimension1: value,
+                                dimension2: value == "none" ? "none" : dimension2,
+                            });
+                        }, options: allDimensions })),
+                type != "line" && type != "radar" && (React.createElement(PanelRow, null,
+                    React.createElement(SelectControl, { multiple: false, label: __(type == "map" ? "Breakdown Field" : "Second Dimension"), value: dimension2, onChange: (value) => {
+                            setAttributes({ dimension2: value });
+                        }, options: allDimensions, disabled: dimension1 == "none" })))),
+            React.createElement(Measures, { ...this.props, onFormatChange: this.onFormatChange, onUseCustomAxisFormatChange: this.onUseCustomAxisFormatChange, onSetSingleMeasure: this.onSetSingleMeasure, onMeasuresChange: this.onMeasuresChange, onCustomLabelToggleChange: this.onCustomLabelToggleChange, onCustomLabelChange: this.onCustomLabelChange, currentType: currentType }),
+            React.createElement(React.Fragment, null,
+                React.createElement(PanelBody, { initialOpen: false, title: __("Filters") },
+                    filters.map((f, index) => {
+                        return (React.createElement(PanelBody, { initialOpen: true, title: __(`Filter - ${f.label}`) },
+                            React.createElement(FilterSelector, { param: f.param, index: index, options: allFilters, onUpdateFilterParam: this.updateFilterParam }),
+                            React.createElement(CategoricalFilter, { value: f.value, index: index, items: this.items(f.type), onUpdateFilterValue: this.updateFilterValue })));
+                    }),
+                    React.createElement(PanelRow, null,
+                        React.createElement(Button, { variant: "link", onClick: this.addFilter }, __("Add Filter")),
+                        React.createElement(Button, { variant: "link", onClick: this.removeFilter }, __("Remove"))))),
+        ];
+    }
+}
+export default APIConfig;

package/build/APIutils.d.ts

@@ -0,0 +1,4 @@
+export declare const getTranslatedOptions: (options: any[]) => any[];
+export declare const getTranslation: (translatable: any) => any;
+export declare const isSupersetAPI: (app: string, apps: any[]) => any;
+export default getTranslatedOptions;

package/build/APIutils.js

@@ -0,0 +1,30 @@
+export const getTranslatedOptions = (options) => {
+    const currentLocale = (window._user_locale ? window._user_locale : '').toUpperCase();
+    if (options && options instanceof Array) {
+        return options.map(o => {
+            let { label, value, labels } = o;
+            if (labels && labels[currentLocale]) {
+                label = labels[currentLocale];
+            }
+            return { ...o, label, value };
+        });
+    }
+    return [];
+};
+export const getTranslation = (translatable) => {
+    const currentLocale = (window._user_locale ? window._user_locale : '').toUpperCase();
+    let { label, labels, value } = translatable;
+    if (labels && labels[currentLocale]) {
+        label = labels[currentLocale];
+    }
+    return label || value || translatable;
+};
+export const isSupersetAPI = (app, apps) => {
+    if (app == 'csv' || !apps) {
+        return false;
+    }
+    const appObj = apps.filter(a => a.value == app)[0];
+    return appObj && appObj.settings && appObj.settings.metadata
+        && appObj.settings.metadata.superset == 'true';
+};
+export default getTranslatedOptions;

package/build/Blocks.d.ts

@@ -0,0 +1,90 @@
+import React from 'react';
+import { Component } from '@wordpress/element';
+import { Taxonomies, Taxonomy, Wp_Types } from './types';
+export interface SizeConfigProps {
+    height: number;
+    setAttributes: (attributes: any) => void;
+    panelStatus: any;
+    initialOpen?: boolean;
+}
+export declare const SizeConfig: ({ height, setAttributes, panelStatus, initialOpen }: SizeConfigProps) => React.JSX.Element;
+export type ComponentWithSettingsProps = {
+    attributes: any;
+    setAttributes: (attributes: any) => void;
+};
+export type ComponentWithSettingsState = {
+    react_ui_url?: string;
+    react_api_url?: string | null;
+    apache_superset_url?: string | boolean | null;
+    site_language?: string;
+    current_language?: string;
+    previewMode?: string;
+};
+export declare class ComponentWithSettings<T extends ComponentWithSettingsProps, U extends ComponentWithSettingsState> extends Component<T, U> {
+    iframe: React.RefObject<HTMLIFrameElement>;
+    unsubscribe: () => void;
+    constructor(props: T);
+    componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+}
+export type BlockEditWithFiltersProps = {
+    attributes: any;
+    setAttributes: (attributes: any) => void;
+};
+export interface BlockEditWithFiltersState extends ComponentWithSettingsState {
+    taxonomyValues: Taxonomy[] | null;
+    types: Wp_Types[] | null;
+    taxonomies: Taxonomies | null;
+    loading: boolean;
+}
+export declare class BlockEditWithFilters<T extends BlockEditWithFiltersProps = BlockEditWithFiltersProps, S extends BlockEditWithFiltersState = BlockEditWithFiltersState> extends ComponentWithSettings<T, S> {
+    constructor(props: T);
+    componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
+    componentDidMount(): void;
+    onTypeChanged(value: any): void;
+    onTaxonomyChanged(value: any): void;
+    onCategoryChanged(checked: any, value: any): void;
+    getTaxonomyValues(): void;
+    getTaxonomies(): void;
+    getTypes(): void;
+    typeOptions(): {
+        slug: any;
+        label: any;
+        value: any;
+    }[];
+    taxonomyOptions(): {
+        label: string;
+        value: string;
+    }[];
+    categoriesOptions(): {
+        label: string;
+        value: number;
+    }[];
+    renderFilters(): React.JSX.Element;
+}
+export type BlockEditWithAPIMetadataProps = {
+    attributes: {
+        app: string;
+        dvzProxyDatasetId?: string;
+    };
+    setAttributes: (attributes: any) => void;
+};
+export type BlockEditWithAPIMetadataState = {
+    apps: any[];
+    datasets?: any[];
+    dimensions?: any[];
+    filters?: any[];
+    measures?: any[];
+    categories?: any[];
+} & ComponentWithSettingsState;
+export declare class BlockEditWithAPIMetadata<T extends BlockEditWithAPIMetadataProps = BlockEditWithAPIMetadataProps, S extends BlockEditWithAPIMetadataState = BlockEditWithAPIMetadataState> extends ComponentWithSettings<T, S> {
+    constructor(props: T);
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: BlockEditWithAPIMetadataProps, prevState: any, snapshot?: any): void;
+    evictSuperSetCache(): void;
+    loadDatasets(app: any): void;
+    loadMetadata(app: string, dvzProxyDatasetId?: string): void;
+    fetchData(url: string, stateKey: string, transformData: (data: any) => any): void;
+}
+export default SizeConfig;