@qrvey/utils 1.6.0-0 → 1.6.0-1

package/dist/filters/constants/settings/FILTER_SETTINGS_DEFAULT.js

@@ -0,0 +1,236 @@
+import { FILTER_SCOPE } from "../common/FILTER_SCOPE";
+import { FILTER_PANEL_VIEW } from "../panel/FILTER_PANEL_VIEW";
+export const FILTER_SETTINGS_DEFAULT = {
+    chartBuilder: {
+        addFilterDisplayed: true,
+        addFilterEnabled: true,
+        filterSectionDisplayed: true,
+    },
+    filterBuilder: {
+        scopeSelectorDisplayed: true,
+        scopeSelectorEnabled: true,
+    },
+    filterDisplayer: {
+        addFilterDisplayed: true,
+        addFilterEnabled: true,
+        displayed: true,
+    },
+    filterPanel: {
+        body: {
+            dataset: {
+                canCollapse: true,
+                collapsed: false,
+                headerDisplayed: true,
+                iconDisplayed: true,
+            },
+            filter: {
+                canCollapse: true,
+                collapsed: true,
+                enabled: true,
+                menu: {
+                    deleteDisplayed: true,
+                    deleteEnabled: true,
+                    displayed: true,
+                    editDisplayed: true,
+                    editEnabled: true,
+                    enableDisplayed: true,
+                    enableEnabled: true,
+                },
+                readonly: false,
+            },
+            operator: {
+                displayed: true,
+                readonly: false,
+            },
+            scope: {
+                canCollapse: true,
+                collapsed: false,
+                headerDisplayed: true,
+            },
+        },
+        canCollapse: true,
+        collapsed: true,
+        colorized: true,
+        displayed: true,
+        dynamicFilters: false,
+        enabled: true,
+        header: {
+            displayed: true,
+            filterButtonDisplayed: true,
+            filterButtonEnabled: true,
+            menu: {
+                deleteDisplayed: true,
+                deleteEnabled: true,
+                displayed: true,
+                enableDisplayed: true,
+                enableEnabled: true,
+            },
+            readonly: false,
+            settingsButtonDisplayed: true,
+            settingsButtonEnabled: true,
+        },
+        iconsDisplayed: true,
+        readonly: false,
+        updateFilterInfo: true,
+    },
+    filterPanelSettings: {
+        displayColorModeDisplayed: true,
+        displayColorModeEnabled: true,
+        displayIconsDisplayed: true,
+        displayIconsEnabled: true,
+        panelDefaultView: FILTER_PANEL_VIEW.OPENED,
+        panelDefaultViewDisplayed: true,
+        panelDefaultViewEnabled: true,
+        showPanelInPageView: true,
+        showPanelInPageViewDisplayed: true,
+        showPanelInPageViewEnabled: true,
+    },
+    panel: {
+        filterAccessDisplayed: true,
+        filterAccessEnabled: true,
+        filterByDisplayed: true,
+        filterByEnabled: true,
+        seeDataDisplayed: true,
+        seeDataEnabled: true,
+    },
+    scopes: {
+        [FILTER_SCOPE.DATA]: {
+            canCollapse: true,
+            collapsed: false,
+            color: "#C0C0C0",
+            colorized: true,
+            colorPickerDisplayed: true,
+            displayed: false,
+            enabled: true,
+            icon: "fp-global",
+            iconsDisplayed: true,
+            interaction: {
+                createDisplayed: true,
+                createEnabled: true,
+                deleteDisplayed: true,
+                deleteEnabled: true,
+                editDisplayed: true,
+                editEnabled: true,
+                enableDisplayed: true,
+                enableEnabled: true,
+            },
+            label: undefined,
+            readonly: false,
+        },
+        [FILTER_SCOPE.GLOBAL]: {
+            canCollapse: true,
+            collapsed: false,
+            color: "#4FA6DA",
+            colorized: true,
+            colorPickerDisplayed: true,
+            displayed: false,
+            enabled: true,
+            icon: "fp-global",
+            iconsDisplayed: true,
+            interaction: {
+                createDisplayed: true,
+                createEnabled: true,
+                deleteDisplayed: true,
+                deleteEnabled: true,
+                editDisplayed: true,
+                editEnabled: true,
+                enableDisplayed: true,
+                enableEnabled: true,
+            },
+            label: undefined,
+            readonly: false,
+        },
+        [FILTER_SCOPE.PAGE]: {
+            canCollapse: true,
+            collapsed: false,
+            color: "#7DC58C",
+            colorized: true,
+            colorPickerDisplayed: true,
+            displayed: false,
+            enabled: true,
+            icon: "fp-page",
+            iconsDisplayed: true,
+            interaction: {
+                createDisplayed: true,
+                createEnabled: true,
+                deleteDisplayed: true,
+                deleteEnabled: true,
+                editDisplayed: true,
+                editEnabled: true,
+                enableDisplayed: true,
+                enableEnabled: true,
+            },
+            label: undefined,
+            readonly: false,
+        },
+        [FILTER_SCOPE.TAB]: {
+            canCollapse: true,
+            collapsed: false,
+            color: "#E6773D",
+            colorized: true,
+            colorPickerDisplayed: true,
+            displayed: false,
+            enabled: true,
+            icon: "fp-tab",
+            iconsDisplayed: true,
+            interaction: {
+                createDisplayed: true,
+                createEnabled: true,
+                deleteDisplayed: true,
+                deleteEnabled: true,
+                editDisplayed: true,
+                editEnabled: true,
+                enableDisplayed: true,
+                enableEnabled: true,
+            },
+            label: undefined,
+            readonly: false,
+        },
+        [FILTER_SCOPE.CHART]: {
+            canCollapse: true,
+            collapsed: false,
+            color: "#FFB75D",
+            colorized: true,
+            colorPickerDisplayed: true,
+            displayed: false,
+            enabled: true,
+            icon: "fp-chart",
+            iconsDisplayed: true,
+            interaction: {
+                createDisplayed: true,
+                createEnabled: true,
+                deleteDisplayed: true,
+                deleteEnabled: true,
+                editDisplayed: true,
+                editEnabled: true,
+                enableDisplayed: true,
+                enableEnabled: true,
+            },
+            label: undefined,
+            readonly: false,
+        },
+        [FILTER_SCOPE.DEFAULT]: {
+            canCollapse: true,
+            collapsed: false,
+            color: "#C0C0C0",
+            colorized: true,
+            colorPickerDisplayed: true,
+            displayed: false,
+            enabled: true,
+            icon: "fp-global",
+            iconsDisplayed: true,
+            interaction: {
+                createDisplayed: true,
+                createEnabled: true,
+                deleteDisplayed: true,
+                deleteEnabled: true,
+                editDisplayed: true,
+                editEnabled: true,
+                enableDisplayed: true,
+                enableEnabled: true,
+            },
+            label: undefined,
+            readonly: false,
+        },
+    },
+};

package/dist/filters/constants/settings/index.d.ts

@@ -0,0 +1 @@
+export * from "./FILTER_SETTINGS_DEFAULT";

package/dist/filters/constants/settings/index.js

@@ -0,0 +1 @@
+export * from "./FILTER_SETTINGS_DEFAULT";

package/dist/filters/helpers/backend/getLogicByDatasets.js

@@ -1,5 +1,6 @@
-import { filterNestedTree, _hasProperty } from "../../../general";
+import { filterNestedTree } from "../../../general/array/filterNestedTree";
 import { isEmpty } from "../../../general/mix/isEmpty";
+import { _hasProperty } from "../../../general/object/hasProperty";
 /**
  * [TODO: Add filterEmptyArrays to the filterNestedTree filter condition. Firstly, that function should accept this argument]
  * Filters the logic by a qrveyids array

package/dist/filters/helpers/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./backend/index";
 export * from "./builder/index";
 export * from "./common/index";
+export * from "./settings/index";
 export * from "./ui/index";
 export * from "./applyHierarchyForAggFilters";
 export * from "./getAvailableScopes";

package/dist/filters/helpers/index.js

@@ -1,6 +1,7 @@
 export * from "./backend/index";
 export * from "./builder/index";
 export * from "./common/index";
+export * from "./settings/index";
 export * from "./ui/index";
 export * from "./applyHierarchyForAggFilters";
 export * from "./getAvailableScopes";

package/dist/filters/helpers/settings/areMultipleScopesByProperties.d.ts

@@ -0,0 +1,9 @@
+import { IFSettings } from "../../interfaces/settings/IFSettings";
+/**
+ * Validates if the scope settings is satisfied by properties in multiple scopes
+ * @param {IFSettings} settings the filter setting
+ * @param {string} scopeProperties the property or the string path of the scope settings
+ * @param {string} condition validate with AND or OR condition
+ * @returns true iif there are scopes to be satisfied; false: one or none scopes to be satisfied
+ */
+export declare function areMultipleScopesByProperties(settings: IFSettings, scopeProperties: string[], condition?: "AND" | "OR"): boolean;

package/dist/filters/helpers/settings/areMultipleScopesByProperties.js

@@ -0,0 +1,20 @@
+import { isEmpty } from "../../../general/mix/isEmpty";
+import { _get } from "../../../general/object/get";
+import { getScopesSettings } from "./getScopesSettings";
+/**
+ * Validates if the scope settings is satisfied by properties in multiple scopes
+ * @param {IFSettings} settings the filter setting
+ * @param {string} scopeProperties the property or the string path of the scope settings
+ * @param {string} condition validate with AND or OR condition
+ * @returns true iif there are scopes to be satisfied; false: one or none scopes to be satisfied
+ */
+export function areMultipleScopesByProperties(settings, scopeProperties, condition = "AND") {
+    if (isEmpty(settings) || isEmpty(settings.scopes))
+        return false;
+    const scopes = Object.keys(settings.scopes);
+    const conditionFunction = (scope) => (property) => _get(scope, property, false);
+    return (scopes.length > 0 &&
+        getScopesSettings(settings.scopes).filter((scope) => condition === "AND"
+            ? scopeProperties.every(conditionFunction(scope))
+            : scopeProperties.some(conditionFunction(scope))).length > 0);
+}

package/dist/filters/helpers/settings/areMultipleScopesByProperty.d.ts

@@ -0,0 +1,8 @@
+import { IFSettings } from "../../interfaces/settings/IFSettings";
+/**
+ * Validates if the scope settings is satisfied the property in multiple scopes
+ * @param {IFSettings} settings the filter setting
+ * @param {string} property the property or the string path of the scope settings
+ * @returns true if there are scopes to be satisfied; false: one or none scopes to be satisfied
+ */
+export declare function areMultipleScopesByProperty(settings: IFSettings, property: string): boolean;

package/dist/filters/helpers/settings/areMultipleScopesByProperty.js

@@ -0,0 +1,16 @@
+import { isEmpty } from "../../../general/mix/isEmpty";
+import { _get } from "../../../general/object/get";
+import { getScopesSettings } from "./getScopesSettings";
+/**
+ * Validates if the scope settings is satisfied the property in multiple scopes
+ * @param {IFSettings} settings the filter setting
+ * @param {string} property the property or the string path of the scope settings
+ * @returns true if there are scopes to be satisfied; false: one or none scopes to be satisfied
+ */
+export function areMultipleScopesByProperty(settings, property) {
+    if (isEmpty(settings) || isEmpty(settings.scopes))
+        return false;
+    const scopes = Object.keys(settings.scopes);
+    return (scopes.length > 1 &&
+        getScopesSettings(settings.scopes).filter((scope) => _get(scope, property, false)).length > 1);
+}

package/dist/filters/helpers/settings/getFilterSettings.d.ts

@@ -0,0 +1,13 @@
+import { IFScope } from "../../interfaces/IFScope";
+import { IFSettings } from "../../interfaces/settings/IFSettings";
+/**
+ * Gets a new filter settings object according to various conditions
+ * - By allowed scopes. Different implementation could accept some scopes, so the forbidden scopes into the filter settings will be skipped
+ * - If there is not filter settings provived, a default one is returned
+ * - The returned filter settings depend on the coexisting scopes
+ * @param {IFSettings} filterSettings the given filter settings
+ * @param {IFScope[]} allowedScopes a collection of scope types that are permitted
+ * @param {IFSettings} otherSettings another filter settings object to be merged with the filterSettings param
+ * @returns a new filter settings object
+ */
+export declare function getFilterSettings(filterSettings: IFSettings, allowedScopes?: IFScope[], otherSettings?: IFSettings): IFSettings;

package/dist/filters/helpers/settings/getFilterSettings.js

@@ -0,0 +1,327 @@
+import { isEmpty } from "../../../general/mix/isEmpty";
+import { cloneDeep } from "../../../general/object/cloneDeep";
+import { mergeDeep } from "../../../general/object/mergeDeep";
+import { FILTER_SCOPE } from "../../constants/common/FILTER_SCOPE";
+import { FILTER_SETTINGS_DEFAULT } from "../../constants/settings/FILTER_SETTINGS_DEFAULT";
+import { getScopesToDisplay } from "./getScopesToDisplay";
+/**
+ * Gets a new filter settings object according to various conditions
+ * - By allowed scopes. Different implementation could accept some scopes, so the forbidden scopes into the filter settings will be skipped
+ * - If there is not filter settings provived, a default one is returned
+ * - The returned filter settings depend on the coexisting scopes
+ * @param {IFSettings} filterSettings the given filter settings
+ * @param {IFScope[]} allowedScopes a collection of scope types that are permitted
+ * @param {IFSettings} otherSettings another filter settings object to be merged with the filterSettings param
+ * @returns a new filter settings object
+ */
+export function getFilterSettings(filterSettings, allowedScopes = [], otherSettings) {
+    let settings = mergeDeep(FILTER_SETTINGS_DEFAULT, cloneDeep(filterSettings));
+    settings = mergeDeep(settings, otherSettings);
+    const scopesSettings = getScopesToDisplay(settings).filter((scope) => allowedScopes.includes(scope.id));
+    if (scopesSettings.length > 1) {
+        settings = getFilterSettingsByMultipleScopes(settings, allowedScopes);
+    }
+    else if (scopesSettings.length > 0) {
+        settings = getFilterSettingsByOnlyScope(settings, allowedScopes);
+    }
+    else {
+        settings = getFilterSettingsByNoScopes(settings);
+    }
+    return settings;
+}
+/**
+ * Gets the filter settings by multiple scopes conditions
+ * @param {IFSettings} settings the given filter settings
+ * @param {IFScope[]} allowedScopes a collection of scope types that are permitted
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByMultipleScopes(settings, allowedScopes) {
+    const scopesSettings = getScopesToDisplay(settings).filter((scope) => allowedScopes.includes(scope.id));
+    let newSettings = settings;
+    if (isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.DEFAULT))) {
+        newSettings = getFilterSettingsByNoDefaultScope(newSettings);
+    }
+    else if (scopesSettings.length <= 2) {
+        newSettings = getFilterSettingsByDefaultWithOneAdditionalScope(newSettings);
+    }
+    if (isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.CHART))) {
+        newSettings = getFilterSettingsByMultipleNoPanelScopes(newSettings);
+    }
+    if (isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.CHART)) &&
+        isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.GLOBAL)) &&
+        isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.PAGE)) &&
+        isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.TAB))) {
+        newSettings = getFilterSettingsBySkippingGeneralScopes(newSettings);
+    }
+    return newSettings;
+}
+/**
+ * Gets the filter settings when a single scope is permitted
+ * @param {IFSettings} settings the given filter settings
+ * @param {IFScope[]} allowedScopes a collection of scope types that are permitted
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByOnlyScope(settings, allowedScopes) {
+    const scopesSettings = getScopesToDisplay(settings).filter((scope) => allowedScopes.includes(scope.id));
+    let newSettings = getFilterSettingsByGeneralOnlyScope(settings);
+    if (isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.DEFAULT))) {
+        newSettings = getFilterSettingsByNoDefaultScope(newSettings);
+    }
+    else {
+        newSettings = getFilterSettingsByOnlyDefaultScope(newSettings);
+    }
+    if (!isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.CHART))) {
+        newSettings = getFilterSettingsByOnlyPanelScope(newSettings);
+    }
+    if (!isEmpty(scopesSettings.find((scope) => scope.id === FILTER_SCOPE.DATA))) {
+        newSettings = getFilterSettingsByOnlyDataScope(newSettings);
+    }
+    return newSettings;
+}
+/**
+ * Gets the filter settings when there is not scope to accept
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByNoScopes(settings) {
+    const newSettings = {
+        chartBuilder: {
+            addFilterDisplayed: false,
+            filterSectionDisplayed: false,
+        },
+        filterBuilder: {
+            scopeSelectorDisplayed: false,
+        },
+        filterDisplayer: {
+            addFilterDisplayed: false,
+            displayed: false,
+        },
+        filterPanel: {
+            body: {
+                dataset: {
+                    headerDisplayed: false,
+                },
+                filter: {
+                    menu: {
+                        deleteDisplayed: false,
+                        displayed: false,
+                        editDisplayed: false,
+                        enableDisplayed: false,
+                    },
+                },
+                scope: {
+                    headerDisplayed: false,
+                },
+            },
+            colorized: false,
+            displayed: false,
+            header: {
+                filterButtonDisplayed: false,
+                menu: {
+                    deleteDisplayed: false,
+                    displayed: false,
+                    enableDisplayed: false,
+                },
+            },
+        },
+        filterPanelSettings: {
+            displayColorModeDisplayed: false,
+            displayIconsDisplayed: false,
+            panelDefaultViewDisplayed: false,
+            showPanelInPageViewDisplayed: false,
+        },
+        panel: {
+            filterAccessDisplayed: false,
+            filterByDisplayed: false,
+            seeDataDisplayed: false,
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}
+/**
+ * Gets the filter settings when a general scope are only permitted
+ * The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByGeneralOnlyScope(settings) {
+    const newSettings = {
+        filterBuilder: {
+            scopeSelectorDisplayed: false,
+        },
+        filterPanel: {
+            body: {
+                dataset: {
+                    headerDisplayed: false,
+                },
+                scope: {
+                    headerDisplayed: false,
+                },
+            },
+            colorized: false,
+        },
+        filterPanelSettings: {
+            displayColorModeDisplayed: false,
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}
+/**
+ * Gets the filter settings when there is not a default scope type
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByNoDefaultScope(settings) {
+    const newSettings = {
+        chartBuilder: {
+            addFilterDisplayed: false,
+            filterSectionDisplayed: false,
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}
+/**
+ * Gets the filter settings when there is only a default scope type
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByOnlyDefaultScope(settings) {
+    const newSettings = {
+        filterDisplayer: {
+            addFilterDisplayed: false,
+            addFilterEnabled: false,
+            displayed: false,
+        },
+        filterPanel: {
+            body: {
+                filter: {
+                    menu: {
+                        deleteDisplayed: false,
+                        displayed: false,
+                        editDisplayed: false,
+                        enableDisplayed: false,
+                    },
+                    readonly: true,
+                },
+                operator: {
+                    displayed: false,
+                    readonly: true,
+                },
+            },
+            displayed: false,
+            header: {
+                displayed: false,
+                filterButtonDisplayed: false,
+                menu: {
+                    deleteDisplayed: false,
+                    displayed: false,
+                    enableDisplayed: false,
+                },
+                readonly: true,
+                settingsButtonDisplayed: false,
+            },
+            readonly: true,
+        },
+        panel: {
+            filterAccessDisplayed: false,
+            filterByDisplayed: false,
+            seeDataDisplayed: false,
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}
+/**
+ * Gets the filter settings when there are a default scope and other single scope
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByDefaultWithOneAdditionalScope(settings) {
+    const newSettings = {
+        filterPanel: {
+            body: {
+                dataset: {
+                    headerDisplayed: false,
+                },
+                scope: {
+                    headerDisplayed: false,
+                },
+            },
+            colorized: false,
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}
+/**
+ * Gets the filter settings when there is only the panel scope
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByOnlyPanelScope(settings) {
+    const newSettings = {
+        chartBuilder: {
+            addFilterDisplayed: false,
+            filterSectionDisplayed: false,
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}
+/**
+ * Gets the filter settings when there is only the data scope
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByOnlyDataScope(settings) {
+    const newSettings = {
+        filterDisplayer: {
+            addFilterDisplayed: false,
+            displayed: false,
+        },
+        panel: {
+            filterAccessDisplayed: false,
+            filterByDisplayed: false,
+            seeDataDisplayed: false,
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}
+/**
+ * Gets the filter settings when there are not general scopes allowed
+ * The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsBySkippingGeneralScopes(settings) {
+    const newSettings = {
+        panel: {
+            filterAccessDisplayed: false,
+            filterByDisplayed: false,
+            seeDataDisplayed: false,
+        },
+        filterPanel: {
+            header: {
+                filterButtonDisplayed: false,
+                menu: {
+                    displayed: false,
+                },
+                settingsButtonDisplayed: false,
+            },
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}
+/**
+ * Gets the filter settings when there are no panel scopes and multiple scopes allowed.
+ * @param {IFSettings} settings the given filter settings
+ * @returns a new filter settings object
+ */
+function getFilterSettingsByMultipleNoPanelScopes(settings) {
+    const newSettings = {
+        filterDisplayer: {
+            addFilterDisplayed: false,
+        },
+        panel: {
+            filterAccessEnabled: false,
+        },
+    };
+    return mergeDeep(settings, newSettings);
+}

package/dist/filters/helpers/settings/getScopeColorSetting.d.ts

@@ -0,0 +1,9 @@
+import { IFScope } from "../../interfaces/IFScope";
+import { IFSettings } from "../../interfaces/settings/IFSettings";
+/**
+ * Gets the color of the scope in the settings object
+ * @param {IFSettings} settings the filter settings
+ * @param {IFScope} scope the scope type
+ * @returns an string with the color.
+ */
+export declare function getScopeColorSetting(settings: IFSettings, scope: IFScope): string;