@qrvey/utils 1.3.2 → 1.4.0-1

package/dist/filters/services/UChartApi.js

@@ -1,244 +1,282 @@
-import { isDateColumn } from '../../columns/helpers/isDateColumn';
-import { isNumericalColumn } from '../../columns/helpers/isNumericalColumn';
-import { isRangeValidator } from '../helpers/common/isRangeValidator';
-import { cloneDeep } from '../../general/object/cloneDeep';
-import { isEmpty } from '../../general/mix/isEmpty';
-import { COLUMN } from '../../columns/constants/COLUMN';
-import { getAggFiltersBySummaryIndex } from '../helpers/backend/getAggFiltersBySummaryIndex';
-import { _get } from '../../general/object/get';
-import { AGGREGATE } from '../../charts/constants/AGGREGATE';
-import { FILTER_VALIDATOR } from '../constants/common/FILTER_VALIDATOR';
-import { flatUIToOldLogic } from '../adapters/flatUIToOldLogic';
-import ChartsApi from '../../services/api/Charts.api';
-import { getAggFilters } from '../helpers/OLD_getAggFilters';
+import { isDateColumn } from "../../columns/helpers/isDateColumn";
+import { isNumericalColumn } from "../../columns/helpers/isNumericalColumn";
+import { isRangeValidator } from "../helpers/common/isRangeValidator";
+import { cloneDeep } from "../../general/object/cloneDeep";
+import { isEmpty } from "../../general/mix/isEmpty";
+import { COLUMN } from "../../columns/constants/COLUMN";
+import { getAggFiltersBySummaryIndex } from "../helpers/backend/getAggFiltersBySummaryIndex";
+import { _get } from "../../general/object/get";
+import { AGGREGATE } from "../../charts/constants/AGGREGATE";
+import { FILTER_VALIDATOR } from "../constants/common/FILTER_VALIDATOR";
+import { flatUIToOldLogic } from "../adapters/flatUIToOldLogic";
+import ChartsApi from "../../services/api/Charts.api";
+import { getAggFilters } from "../helpers/OLD_getAggFilters";
 export default class UChartApi {
-    constructor() {
-        /**
-         * Gets a promise with a resulting data
-         * @param config the config
-         * @param uFilter The filter Builder filter
-         * @param filterLogic Additional filter logic to apply in the preview
-         * @param chartSettings The settings of the chart. For Aggregate Columns.
-         * @returns a promise with a resulting data
-         */
-        this.getChartResult = (config, uFilter, filterLogic = [], chartSettings, _resetApi = false) => {
-            const requestBody = this._getPreviewRequestBody(uFilter, filterLogic, chartSettings);
-            const customChartApi = new ChartsApi(Object.assign(Object.assign({}, config), { qrvey_id: isEmpty(uFilter.column.aggregate) ? uFilter.column.qrveyid : chartSettings === null || chartSettings === void 0 ? void 0 : chartSettings.qrveyid }));
-            return customChartApi.getResults(requestBody, false, true).then(response => {
-                return this._getDataFromResponse(response, uFilter);
-            }).catch(_ => {
-                return { data: [] };
-            });
-        };
-        /**
-         * Gets request body structure
-         * @param uFilter The filter Builder filter
-         * @param filterLogic Additional filter logic to apply in the preview
-         * @param chartSettings The settings of the chart. For Aggregate Columns.
-         * @returns the request body structure
-         */
-        this._getPreviewRequestBody = (uFilter, filterLogic = [], chartSettings) => {
-            const { column, validator } = uFilter;
-            const haveAggFilters = ((chartSettings === null || chartSettings === void 0 ? void 0 : chartSettings.aggregateColumns) || []).length && ((chartSettings === null || chartSettings === void 0 ? void 0 : chartSettings.chart) || []).length;
-            let searchLogic;
-            if (!isEmpty(uFilter.values)) {
-                searchLogic = flatUIToOldLogic([Object.assign(Object.assign({}, uFilter), { validator: this._getValidationType(column, validator), column: Object.assign(Object.assign({}, uFilter.column), { linkid: undefined }) })]);
-            }
-            let filterCharts = [];
-            if (haveAggFilters) {
-                filterCharts = chartSettings === null || chartSettings === void 0 ? void 0 : chartSettings.chart.map(chart => {
-                    if (uFilter.column.type === COLUMN.AGGREGATED_FORMULA)
-                        return chart;
-                    const summaryIndex = (chart.summaries || []).findIndex(s => s.questionid === uFilter.column.id && s.aggregate === uFilter.column.aggregate);
-                    const summary = summaryIndex !== -1 && chart.summaries[summaryIndex];
-                    const chartAggFilters = getAggFiltersBySummaryIndex(chart.aggFilters, summaryIndex);
-                    const searchAggFilters = getAggFilters((searchLogic === null || searchLogic === void 0 ? void 0 : searchLogic.logic) || [], summary ? [summary] : []);
-                    return Object.assign(Object.assign({}, chart), { aggFilters: searchAggFilters || chartAggFilters, summaries: summary ? [summary] : [] });
-                }).filter(chart => chart.summaries.length);
-            }
-            const chartsBody = !filterCharts[0] ? [this._getChartBody(uFilter)] : [filterCharts[0]];
-            const filters = [
-                ...filterLogic,
-                ...!filterCharts[0] ? (searchLogic === null || searchLogic === void 0 ? void 0 : searchLogic.logic) || [] : []
+    /**
+     * Gets a promise with a resulting data
+     * @param config the config
+     * @param uFilter The filter Builder filter
+     * @param filterLogic Additional filter logic to apply in the preview
+     * @param chartSettings The settings of the chart. For Aggregate Columns.
+     * @returns a promise with a resulting data
+     */
+    getChartResult = (config, uFilter, filterLogic = [], chartSettings, _resetApi = false) => {
+        const requestBody = this._getPreviewRequestBody(uFilter, filterLogic, chartSettings);
+        const customChartApi = new ChartsApi({
+            ...config,
+            qrvey_id: isEmpty(uFilter.column.aggregate)
+                ? uFilter.column.qrveyid
+                : chartSettings?.qrveyid,
+        });
+        return customChartApi
+            .getResults(requestBody, false, true)
+            .then((response) => {
+            return this._getDataFromResponse(response, uFilter);
+        })
+            .catch((_) => {
+            return { data: [] };
+        });
+    };
+    /**
+     * Gets request body structure
+     * @param uFilter The filter Builder filter
+     * @param filterLogic Additional filter logic to apply in the preview
+     * @param chartSettings The settings of the chart. For Aggregate Columns.
+     * @returns the request body structure
+     */
+    _getPreviewRequestBody = (uFilter, filterLogic = [], chartSettings) => {
+        const { column, validator } = uFilter;
+        const haveAggFilters = (chartSettings?.aggregateColumns || []).length &&
+            (chartSettings?.chart || []).length;
+        let searchLogic;
+        if (!isEmpty(uFilter.values)) {
+            searchLogic = flatUIToOldLogic([
+                {
+                    ...uFilter,
+                    validator: this._getValidationType(column, validator),
+                    column: { ...uFilter.column, linkid: undefined },
+                },
+            ]);
+        }
+        let filterCharts = [];
+        if (haveAggFilters) {
+            filterCharts = chartSettings?.chart
+                .map((chart) => {
+                if (uFilter.column.type === COLUMN.AGGREGATED_FORMULA)
+                    return chart;
+                const summaryIndex = (chart.summaries || []).findIndex((s) => s.questionid === uFilter.column.id &&
+                    s.aggregate === uFilter.column.aggregate);
+                const summary = summaryIndex !== -1 && chart.summaries[summaryIndex];
+                const chartAggFilters = getAggFiltersBySummaryIndex(chart.aggFilters, summaryIndex);
+                const searchAggFilters = getAggFilters(searchLogic?.logic || [], summary ? [summary] : []);
+                return {
+                    ...chart,
+                    aggFilters: searchAggFilters || chartAggFilters,
+                    summaries: summary ? [summary] : [],
+                };
+            })
+                .filter((chart) => chart.summaries.length);
+        }
+        const chartsBody = !filterCharts[0]
+            ? [this._getChartBody(uFilter)]
+            : [filterCharts[0]];
+        const filters = [
+            ...filterLogic,
+            ...(!filterCharts[0] ? searchLogic?.logic || [] : []),
+        ];
+        return { charts: chartsBody, logic: filters, qrveyid: column.qrveyid };
+    };
+    /**
+     * Gets chart body structure
+     * @param uFilter The filter Builder filter
+     * @param chartSettings The settings of the chart. For Aggregate Columns.
+     * @returns the chart body structure
+     */
+    _getChartBody = (uFilter, chartSettings) => {
+        const dimensions = this._getDimensionsBody(uFilter, chartSettings);
+        const summaries = this._getSummariesBody(uFilter);
+        return { dimensions, summaries };
+    };
+    /**
+     * Gets dimension body structure
+     * @param uFilter The filter Builder filter
+     * @param chartSettings The settings of the chart. For Aggregate Columns.
+     * @returns the dimension body structure
+     */
+    _getDimensionsBody = (uFilter, chartSettings) => {
+        const { column, validator } = uFilter;
+        let dimensions;
+        if (!isRangeValidator(validator)) {
+            dimensions = [
+                {
+                    questionid: column.id,
+                    qrveyid: column.qrveyid,
+                    // linkid: column.linkid,
+                    maxDataPoints: this._getMaxDataPoints(column, chartSettings),
+                    type: column.type,
+                    formulaType: column.type === "FORMULA" ? column.formulaType : undefined,
+                    sortOption: this._getSortOption(column),
+                },
             ];
-            return { charts: chartsBody, logic: filters, qrveyid: column.qrveyid };
-        };
-        /**
-         * Gets chart body structure
-         * @param uFilter The filter Builder filter
-         * @param chartSettings The settings of the chart. For Aggregate Columns.
-         * @returns the chart body structure
-         */
-        this._getChartBody = (uFilter, chartSettings) => {
-            const dimensions = this._getDimensionsBody(uFilter, chartSettings);
-            const summaries = this._getSummariesBody(uFilter);
-            return { dimensions, summaries };
-        };
-        /**
-         * Gets dimension body structure
-         * @param uFilter The filter Builder filter
-         * @param chartSettings The settings of the chart. For Aggregate Columns.
-         * @returns the dimension body structure
-         */
-        this._getDimensionsBody = (uFilter, chartSettings) => {
-            const { column, validator } = uFilter;
-            let dimensions;
-            if (!isRangeValidator(validator)) {
-                dimensions = [{
-                        questionid: column.id,
-                        qrveyid: column.qrveyid,
-                        // linkid: column.linkid,
-                        maxDataPoints: this._getMaxDataPoints(column, chartSettings),
-                        type: column.type,
-                        formulaType: column.type === 'FORMULA' ? column.formulaType : undefined,
-                        sortOption: this._getSortOption(column)
-                    }];
-                dimensions = this._refineBodies([...dimensions], uFilter);
-            }
-            return dimensions;
-        };
-        /**
-         * Gets max data point number
-         * @param column The column to filter
-         * @param chartSettings The settings of the chart. For Aggregate Columns.
-         * @returns max data point number
-         */
-        this._getMaxDataPoints = (column, chartSettings) => {
-            return !isDateColumn(column) && !isEmpty(column.aggregate) ? _get(chartSettings, 'maxDataPoints.option', 1000) : 1000;
-        };
-        /**
-         * Gets sort option structure
-         * @param column The column to filter
-         * @returns sort option structure
-         */
-        this._getSortOption = (column) => {
-            let sortBy = 'CATEGORY';
-            let sortDirection = isNumericalColumn(column) ? 'DESC' : 'ASC';
-            if (!isEmpty(column.sorting)) {
-                sortBy = _get(column.sorting, 'sortBy');
-                sortDirection = _get(column.sorting, 'order');
-                if (sortBy == null)
-                    sortBy = 'VALUE';
-                if (sortDirection == null)
-                    sortDirection = 'DESC';
-            }
-            return { sortBy, sortDirection };
-        };
-        /**
-         * Gets summaries body structure
-         * @param uFilter The filter Builder filter
-         * @returns summaries body structure
-         */
-        this._getSummariesBody = (uFilter) => {
-            const { column, validator } = uFilter;
-            const summary = {
-                aggregate: _get(column, 'aggregate.label', AGGREGATE.COUNT),
-                questionid: column.id,
-                property: !isDateColumn(uFilter.column) ? uFilter.property : undefined,
-                type: column.type
-            };
-            let summaries = [summary];
-            if (isNumericalColumn(column) || isRangeValidator(validator)) {
-                summaries = [
-                    Object.assign(Object.assign({}, summary), { aggregate: AGGREGATE.MIN }),
-                    Object.assign(Object.assign({}, summary), { aggregate: AGGREGATE.MAX })
-                ];
-            }
-            return summaries;
-        };
-        /**
-         * Refines the body structure
-         * @param bodies The body structure
-         * @param uFilter The filter Builder filter
-         * @returns the body structure
-         */
-        this._refineBodies = (bodies, uFilter) => {
-            const _bodies = cloneDeep(bodies);
-            if (uFilter.property != null) {
-                _bodies.forEach(body => {
-                    if (isDateColumn(uFilter.column)) {
-                        body['groupType'] = 'DATE';
-                        body['groupValue'] = uFilter.property.toUpperCase();
-                    }
-                    else {
-                        body['property'] = uFilter.property;
-                    }
-                });
-            }
-            return _bodies;
+            dimensions = this._refineBodies([...dimensions], uFilter);
+        }
+        return dimensions;
+    };
+    /**
+     * Gets max data point number
+     * @param column The column to filter
+     * @param chartSettings The settings of the chart. For Aggregate Columns.
+     * @returns max data point number
+     */
+    _getMaxDataPoints = (column, chartSettings) => {
+        return !isDateColumn(column) && !isEmpty(column.aggregate)
+            ? _get(chartSettings, "maxDataPoints.option", 1000)
+            : 1000;
+    };
+    /**
+     * Gets sort option structure
+     * @param column The column to filter
+     * @returns sort option structure
+     */
+    _getSortOption = (column) => {
+        let sortBy = "CATEGORY";
+        let sortDirection = isNumericalColumn(column) ? "DESC" : "ASC";
+        if (!isEmpty(column.sorting)) {
+            sortBy = _get(column.sorting, "sortBy");
+            sortDirection = _get(column.sorting, "order");
+            if (sortBy == null)
+                sortBy = "VALUE";
+            if (sortDirection == null)
+                sortDirection = "DESC";
+        }
+        return { sortBy, sortDirection };
+    };
+    /**
+     * Gets summaries body structure
+     * @param uFilter The filter Builder filter
+     * @returns summaries body structure
+     */
+    _getSummariesBody = (uFilter) => {
+        const { column, validator } = uFilter;
+        const summary = {
+            aggregate: _get(column, "aggregate.label", AGGREGATE.COUNT),
+            questionid: column.id,
+            property: !isDateColumn(uFilter.column) ? uFilter.property : undefined,
+            type: column.type,
         };
-        /**
-         * Gets the validation type for the preview request
-         * @param column The column to filter
-         * @param vaildator Validator Type
-         * @returns the validator type for the preview request
-         */
-        this._getValidationType = (column, validator) => {
-            if (isDateColumn(column) || column.type === COLUMN.BUCKET || isNumericalColumn(column)) {
-                return FILTER_VALIDATOR.EQUALS;
-            }
-            else {
-                if ([FILTER_VALIDATOR.NOT_CONTAIN, FILTER_VALIDATOR.EQUALS, FILTER_VALIDATOR.NOT_EQUAL].includes(validator)) {
-                    return FILTER_VALIDATOR.CONTAINS;
-                }
-                else if (validator === FILTER_VALIDATOR.NOT_END_WITH) {
-                    return FILTER_VALIDATOR.ENDS_WITH;
-                }
-                else if (validator === FILTER_VALIDATOR.NOT_START_WITH) {
-                    return FILTER_VALIDATOR.STARTS_WITH;
+        let summaries = [summary];
+        if (isNumericalColumn(column) || isRangeValidator(validator)) {
+            summaries = [
+                { ...summary, aggregate: AGGREGATE.MIN },
+                { ...summary, aggregate: AGGREGATE.MAX },
+            ];
+        }
+        return summaries;
+    };
+    /**
+     * Refines the body structure
+     * @param bodies The body structure
+     * @param uFilter The filter Builder filter
+     * @returns the body structure
+     */
+    _refineBodies = (bodies, uFilter) => {
+        const _bodies = cloneDeep(bodies);
+        if (uFilter.property != null) {
+            _bodies.forEach((body) => {
+                if (isDateColumn(uFilter.column)) {
+                    body["groupType"] = "DATE";
+                    body["groupValue"] = uFilter.property.toUpperCase();
                 }
                 else {
-                    return validator;
+                    body["property"] = uFilter.property;
                 }
+            });
+        }
+        return _bodies;
+    };
+    /**
+     * Gets the validation type for the preview request
+     * @param column The column to filter
+     * @param vaildator Validator Type
+     * @returns the validator type for the preview request
+     */
+    _getValidationType = (column, validator) => {
+        if (isDateColumn(column) ||
+            column.type === COLUMN.BUCKET ||
+            isNumericalColumn(column)) {
+            return FILTER_VALIDATOR.EQUALS;
+        }
+        else {
+            if ([
+                FILTER_VALIDATOR.NOT_CONTAIN,
+                FILTER_VALIDATOR.EQUALS,
+                FILTER_VALIDATOR.NOT_EQUAL,
+            ].includes(validator)) {
+                return FILTER_VALIDATOR.CONTAINS;
             }
-        };
-        /**
-         * Gets the Data from preview Response
-         * @param response The preview presponse
-         * @param uFilter The filter Builder filter
-         * @returns The resulting data
-         */
-        this._getDataFromResponse = (response, uFilter) => {
-            const data = { data: [] };
-            if (isRangeValidator(uFilter.validator)) {
-                data.data = isEmpty(uFilter.column.aggregate)
-                    ? _get(response, '[0].summary', []).map(summary => ({ value: summary }))
-                    : [{ value: _get(response, '[0].min') }, { value: _get(response, '[0].max') }];
+            else if (validator === FILTER_VALIDATOR.NOT_END_WITH) {
+                return FILTER_VALIDATOR.ENDS_WITH;
             }
-            else if (!this.isResultEmpty(response)) {
-                const records = _get(response, 'data');
-                data.data = isEmpty(uFilter.column.aggregate)
-                    ? records.map(record => ({
-                        value: record.key.toString()
-                    }))
-                    : this._getResponseSummaries(records);
+            else if (validator === FILTER_VALIDATOR.NOT_START_WITH) {
+                return FILTER_VALIDATOR.STARTS_WITH;
             }
-            return data;
-        };
-        /**
-         * Gets summaries from preview response
-         * @param records The data from preview response
-         * @param values The values from the preview response
-         * @returns the sumaries
-         */
-        this._getResponseSummaries = (records, values = []) => {
-            records.forEach(record => {
-                const value = record.summary[0].toString();
-                if (Array.isArray(record.items) && record.items.length)
-                    values = this._getResponseSummaries(record.items, values);
-                else if (!Array.isArray(record.items) && !isEmpty(values.find(v => v.value === value)))
-                    values.push({ value });
-            });
-            return values;
-        };
-        this.isResultEmpty = (resultObject, validateNesteddata = false) => {
-            const result = _get(resultObject, '[0].data');
-            let validation = isEmpty(result);
-            if (validateNesteddata && !validation) {
-                // Searching empty data when Chart is Multiseries. At least, Chart needs a single item to draw in the serie. (See the second level of the result object)
-                validation = result.every(data => !isEmpty(data) && isEmpty(_get(data, 'items')));
+            else {
+                return validator;
             }
-            return validation;
-        };
-    }
+        }
+    };
+    /**
+     * Gets the Data from preview Response
+     * @param response The preview presponse
+     * @param uFilter The filter Builder filter
+     * @returns The resulting data
+     */
+    _getDataFromResponse = (response, uFilter) => {
+        const data = { data: [] };
+        if (isRangeValidator(uFilter.validator)) {
+            data.data = isEmpty(uFilter.column.aggregate)
+                ? _get(response, "[0].summary", []).map((summary) => ({
+                    value: summary,
+                }))
+                : [
+                    { value: _get(response, "[0].min") },
+                    { value: _get(response, "[0].max") },
+                ];
+        }
+        else if (!this.isResultEmpty(response)) {
+            const records = _get(response, "data");
+            data.data = isEmpty(uFilter.column.aggregate)
+                ? records.map((record) => ({
+                    value: record.key.toString(),
+                }))
+                : this._getResponseSummaries(records);
+        }
+        return data;
+    };
+    /**
+     * Gets summaries from preview response
+     * @param records The data from preview response
+     * @param values The values from the preview response
+     * @returns the sumaries
+     */
+    _getResponseSummaries = (records, values = []) => {
+        records.forEach((record) => {
+            const value = record.summary[0].toString();
+            if (Array.isArray(record.items) && record.items.length)
+                values = this._getResponseSummaries(record.items, values);
+            else if (!Array.isArray(record.items) &&
+                !isEmpty(values.find((v) => v.value === value)))
+                values.push({ value });
+        });
+        return values;
+    };
+    isResultEmpty = (resultObject, validateNesteddata = false) => {
+        const result = _get(resultObject, "[0].data");
+        let validation = isEmpty(result);
+        if (validateNesteddata && !validation) {
+            // Searching empty data when Chart is Multiseries. At least, Chart needs a single item to draw in the serie. (See the second level of the result object)
+            validation = result.every((data) => !isEmpty(data) && isEmpty(_get(data, "items")));
+        }
+        return validation;
+    };
 }