@qrvey/utils 1.6.0-0 → 1.6.0-1

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

@@ -2,3 +2,4 @@ export * from "./backend/index";
 export * from "./builder/index";
 export * from "./common/index";
 export * from "./panel/index";
+export * from "./settings/index";

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

@@ -18,3 +18,4 @@ __exportStar(require("./backend/index"), exports);
 __exportStar(require("./builder/index"), exports);
 __exportStar(require("./common/index"), exports);
 __exportStar(require("./panel/index"), exports);
+__exportStar(require("./settings/index"), exports);

package/dist/cjs/filters/constants/settings/FILTER_SETTINGS_DEFAULT.d.ts

@@ -0,0 +1,3 @@
+import { DeepRequired } from "../../../typescript/DeepRequired";
+import { IFSettings } from "../../interfaces/settings/IFSettings";
+export declare const FILTER_SETTINGS_DEFAULT: DeepRequired<IFSettings>;

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

@@ -0,0 +1,239 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FILTER_SETTINGS_DEFAULT = void 0;
+const FILTER_SCOPE_1 = require("../common/FILTER_SCOPE");
+const FILTER_PANEL_VIEW_1 = require("../panel/FILTER_PANEL_VIEW");
+exports.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_1.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_1.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_1.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_1.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_1.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_1.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_1.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/cjs/filters/constants/settings/index.d.ts

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

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./FILTER_SETTINGS_DEFAULT"), exports);

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

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLogicByDatasets = void 0;
-const general_1 = require("../../../general");
+const filterNestedTree_1 = require("../../../general/array/filterNestedTree");
 const isEmpty_1 = require("../../../general/mix/isEmpty");
+const hasProperty_1 = require("../../../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
@@ -17,10 +18,10 @@ function getLogicByDatasets(logic, datasets = [], settings) {
     if ((0, isEmpty_1.isEmpty)(datasets))
         return logic;
     const defaultSettings = getGetLogicByDatasetsSettings(settings);
-    return logic.map((_l) => (Object.assign(Object.assign({}, _l), { filters: (0, general_1.filterNestedTree)(_l.filters, "expressions", (expression) => {
+    return logic.map((_l) => (Object.assign(Object.assign({}, _l), { filters: (0, filterNestedTree_1.filterNestedTree)(_l.filters, "expressions", (expression) => {
             const dataset = datasets.find((_data) => _data === expression.qrveyid);
             return ((defaultSettings.letPassUndefinedProperties.qrveyid &&
-                !(0, general_1._hasProperty)(expression, "qrveyid")) ||
+                !(0, hasProperty_1._hasProperty)(expression, "qrveyid")) ||
                 !(0, isEmpty_1.isEmpty)(dataset));
         }) })));
 }

package/dist/cjs/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/cjs/filters/helpers/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./backend/index"), exports);
 __exportStar(require("./builder/index"), exports);
 __exportStar(require("./common/index"), exports);
+__exportStar(require("./settings/index"), exports);
 __exportStar(require("./ui/index"), exports);
 __exportStar(require("./applyHierarchyForAggFilters"), exports);
 __exportStar(require("./getAvailableScopes"), exports);

package/dist/cjs/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/cjs/filters/helpers/settings/areMultipleScopesByProperties.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.areMultipleScopesByProperties = void 0;
+const isEmpty_1 = require("../../../general/mix/isEmpty");
+const get_1 = require("../../../general/object/get");
+const getScopesSettings_1 = require("./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
+ */
+function areMultipleScopesByProperties(settings, scopeProperties, condition = "AND") {
+    if ((0, isEmpty_1.isEmpty)(settings) || (0, isEmpty_1.isEmpty)(settings.scopes))
+        return false;
+    const scopes = Object.keys(settings.scopes);
+    const conditionFunction = (scope) => (property) => (0, get_1._get)(scope, property, false);
+    return (scopes.length > 0 &&
+        (0, getScopesSettings_1.getScopesSettings)(settings.scopes).filter((scope) => condition === "AND"
+            ? scopeProperties.every(conditionFunction(scope))
+            : scopeProperties.some(conditionFunction(scope))).length > 0);
+}
+exports.areMultipleScopesByProperties = areMultipleScopesByProperties;

package/dist/cjs/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/cjs/filters/helpers/settings/areMultipleScopesByProperty.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.areMultipleScopesByProperty = void 0;
+const isEmpty_1 = require("../../../general/mix/isEmpty");
+const get_1 = require("../../../general/object/get");
+const getScopesSettings_1 = require("./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
+ */
+function areMultipleScopesByProperty(settings, property) {
+    if ((0, isEmpty_1.isEmpty)(settings) || (0, isEmpty_1.isEmpty)(settings.scopes))
+        return false;
+    const scopes = Object.keys(settings.scopes);
+    return (scopes.length > 1 &&
+        (0, getScopesSettings_1.getScopesSettings)(settings.scopes).filter((scope) => (0, get_1._get)(scope, property, false)).length > 1);
+}
+exports.areMultipleScopesByProperty = areMultipleScopesByProperty;

package/dist/cjs/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;