@qrvey/utils 1.3.0-9 → 1.3.0

package/dist/cjs/filters/services/UChartApi.d.ts

@@ -0,0 +1,86 @@
+import { IFBData } from '../interfaces/backend/IFBData';
+import { IFilterConfig } from '../interfaces/common/IFilterConfig';
+import { IFUFlattenedFilter } from '../interfaces/ui/IFUFlattenedFilter';
+import { IFBLogic } from '../interfaces/backend/IFBLogic';
+import { IFUChartSettings } from '../interfaces/ui/IFUChartSettings';
+export default class UChartApi {
+    /**
+     * 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: IFilterConfig, uFilter: IFUFlattenedFilter, filterLogic?: IFBLogic[], chartSettings?: IFUChartSettings, _resetApi?: boolean) => Promise<IFBData>;
+    /**
+     * 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
+     */
+    private _getPreviewRequestBody;
+    /**
+     * 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
+     */
+    private _getChartBody;
+    /**
+     * 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
+     */
+    private _getDimensionsBody;
+    /**
+     * 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
+     */
+    private _getMaxDataPoints;
+    /**
+     * Gets sort option structure
+     * @param column The column to filter
+     * @returns sort option structure
+     */
+    private _getSortOption;
+    /**
+     * Gets summaries body structure
+     * @param uFilter The filter Builder filter
+     * @returns summaries body structure
+     */
+    private _getSummariesBody;
+    /**
+     * Refines the body structure
+     * @param bodies The body structure
+     * @param uFilter The filter Builder filter
+     * @returns the body structure
+     */
+    private _refineBodies;
+    /**
+     * 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
+     */
+    private _getValidationType;
+    /**
+     * Gets the Data from preview Response
+     * @param response The preview presponse
+     * @param uFilter The filter Builder filter
+     * @returns The resulting data
+     */
+    private _getDataFromResponse;
+    /**
+     * Gets summaries from preview response
+     * @param records The data from preview response
+     * @param values The values from the preview response
+     * @returns the sumaries
+     */
+    private _getResponseSummaries;
+    private isResultEmpty;
+}

package/dist/cjs/filters/services/UChartApi.js

@@ -0,0 +1,250 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const isDateColumn_1 = require("../../columns/helpers/isDateColumn");
+const isNumericalColumn_1 = require("../../columns/helpers/isNumericalColumn");
+const isRangeValidator_1 = require("../helpers/common/isRangeValidator");
+const cloneDeep_1 = require("../../general/object/cloneDeep");
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const COLUMN_1 = require("../../columns/constants/COLUMN");
+const getAggFiltersBySummaryIndex_1 = require("../helpers/backend/getAggFiltersBySummaryIndex");
+const get_1 = require("../../general/object/get");
+const AGGREGATE_1 = require("../../charts/constants/AGGREGATE");
+const FILTER_VALIDATOR_1 = require("../constants/common/FILTER_VALIDATOR");
+const flatUIToOldLogic_1 = require("../adapters/flatUIToOldLogic");
+const Charts_api_1 = __importDefault(require("../../services/api/Charts.api"));
+const OLD_getAggFilters_1 = require("../helpers/OLD_getAggFilters");
+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 Charts_api_1.default(Object.assign(Object.assign({}, config), { qrvey_id: (0, isEmpty_1.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 (!(0, isEmpty_1.isEmpty)(uFilter.values)) {
+                searchLogic = (0, flatUIToOldLogic_1.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_1.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 = (0, getAggFiltersBySummaryIndex_1.getAggFiltersBySummaryIndex)(chart.aggFilters, summaryIndex);
+                    const searchAggFilters = (0, OLD_getAggFilters_1.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) || [] : []
+            ];
+            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 (!(0, isRangeValidator_1.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 !(0, isDateColumn_1.isDateColumn)(column) && !(0, isEmpty_1.isEmpty)(column.aggregate) ? (0, get_1._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 = (0, isNumericalColumn_1.isNumericalColumn)(column) ? 'DESC' : 'ASC';
+            if (!(0, isEmpty_1.isEmpty)(column.sorting)) {
+                sortBy = (0, get_1._get)(column.sorting, 'sortBy');
+                sortDirection = (0, get_1._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: (0, get_1._get)(column, 'aggregate.label', AGGREGATE_1.AGGREGATE.COUNT),
+                questionid: column.id,
+                property: !(0, isDateColumn_1.isDateColumn)(uFilter.column) ? uFilter.property : undefined,
+                type: column.type
+            };
+            let summaries = [summary];
+            if ((0, isNumericalColumn_1.isNumericalColumn)(column) || (0, isRangeValidator_1.isRangeValidator)(validator)) {
+                summaries = [
+                    Object.assign(Object.assign({}, summary), { aggregate: AGGREGATE_1.AGGREGATE.MIN }),
+                    Object.assign(Object.assign({}, summary), { aggregate: AGGREGATE_1.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 = (0, cloneDeep_1.cloneDeep)(bodies);
+            if (uFilter.property != null) {
+                _bodies.forEach(body => {
+                    if ((0, isDateColumn_1.isDateColumn)(uFilter.column)) {
+                        body['groupType'] = 'DATE';
+                        body['groupValue'] = uFilter.property.toUpperCase();
+                    }
+                    else {
+                        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
+         */
+        this._getValidationType = (column, validator) => {
+            if ((0, isDateColumn_1.isDateColumn)(column) || column.type === COLUMN_1.COLUMN.BUCKET || (0, isNumericalColumn_1.isNumericalColumn)(column)) {
+                return FILTER_VALIDATOR_1.FILTER_VALIDATOR.EQUALS;
+            }
+            else {
+                if ([FILTER_VALIDATOR_1.FILTER_VALIDATOR.NOT_CONTAIN, FILTER_VALIDATOR_1.FILTER_VALIDATOR.EQUALS, FILTER_VALIDATOR_1.FILTER_VALIDATOR.NOT_EQUAL].includes(validator)) {
+                    return FILTER_VALIDATOR_1.FILTER_VALIDATOR.CONTAINS;
+                }
+                else if (validator === FILTER_VALIDATOR_1.FILTER_VALIDATOR.NOT_END_WITH) {
+                    return FILTER_VALIDATOR_1.FILTER_VALIDATOR.ENDS_WITH;
+                }
+                else if (validator === FILTER_VALIDATOR_1.FILTER_VALIDATOR.NOT_START_WITH) {
+                    return FILTER_VALIDATOR_1.FILTER_VALIDATOR.STARTS_WITH;
+                }
+                else {
+                    return validator;
+                }
+            }
+        };
+        /**
+         * 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 ((0, isRangeValidator_1.isRangeValidator)(uFilter.validator)) {
+                data.data = (0, isEmpty_1.isEmpty)(uFilter.column.aggregate)
+                    ? (0, get_1._get)(response, '[0].summary', []).map(summary => ({ value: summary }))
+                    : [{ value: (0, get_1._get)(response, '[0].min') }, { value: (0, get_1._get)(response, '[0].max') }];
+            }
+            else if (!this.isResultEmpty(response)) {
+                const records = (0, get_1._get)(response, 'data');
+                data.data = (0, isEmpty_1.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
+         */
+        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) && !(0, isEmpty_1.isEmpty)(values.find(v => v.value === value)))
+                    values.push({ value });
+            });
+            return values;
+        };
+        this.isResultEmpty = (resultObject, validateNesteddata = false) => {
+            const result = (0, get_1._get)(resultObject, '[0].data');
+            let validation = (0, isEmpty_1.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 => !(0, isEmpty_1.isEmpty)(data) && (0, isEmpty_1.isEmpty)((0, get_1._get)(data, 'items')));
+            }
+            return validation;
+        };
+    }
+}
+exports.default = UChartApi;

package/dist/cjs/filters/services/UChartPaginationApi.d.ts

@@ -0,0 +1,114 @@
+import { IFBData } from "../interfaces/backend/IFBData";
+import { IFilterConfig } from "../interfaces/common/IFilterConfig";
+import { IFUFlattenedFilter } from "../interfaces/ui/IFUFlattenedFilter";
+import { IFBLogic } from "../interfaces/backend/IFBLogic";
+import { IFUChartSettings } from "../interfaces/ui/IFUChartSettings";
+import { IFUColumn } from "../interfaces/ui/IFUColumn";
+export default class UChartPaginationApi {
+    afterKey: any;
+    uFilter: IFUFlattenedFilter;
+    /**
+     * Gets afterKey object
+     * @returns the afterKey object
+     */
+    getAfterKey: () => any;
+    /**
+     * 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: IFilterConfig, uFilter: IFUFlattenedFilter, filterLogic?: IFBLogic[], chartSettings?: IFUChartSettings, resetApi?: boolean) => Promise<IFBData>;
+    /**
+     * 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
+     */
+    private _getPreviewRequestBody;
+    /**
+     * Gets dimension body structure
+     * @param uFilter The filter Builder filter
+     * @returns the dimension body structure
+     */
+    private _getDimensionsBody;
+    /**
+     * Get a dimension body structure foor pagination endpoint
+     * @param dimensions
+     * @returns the dimension body structure
+     */
+    private _getDimensionsBodyAdapter;
+    /**
+     * 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
+     */
+    private _getMaxDataPoints;
+    /**
+     * Gets sort option structure
+     * @param column The column to filter
+     * @returns sort option structure
+     */
+    private _getSortOption;
+    /**
+     * Gets summaries body structure
+     * @param uFilter The filter Builder filter
+     * @returns summaries body structure
+     */
+    private _getSummariesBody;
+    /**
+     * Refines the body structure
+     * @param bodies The body structure
+     * @param uFilter The filter Builder filter
+     * @returns the body structure
+     */
+    private _refineBodies;
+    /**
+     * 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
+     */
+    private _getValidationType;
+    /**
+     * Gets the Data from preview Response
+     * @param response The preview presponse
+     * @param uFilter The filter Builder filter
+     * @returns The resulting data
+     */
+    private _getDataFromResponse;
+    /**
+     * Gets summaries from preview response
+     * @param records The data from preview response
+     * @param values The values from the preview response
+     * @returns the sumaries
+     */
+    private _getResponseSummaries;
+    /**
+     * Refines the afterKey object
+     * @param props
+     */
+    private refineAfterkey;
+    /**
+     * Sets the afterKey object
+     * @param afterKey the afterKey object
+     */
+    setAfterKey: (afterKey: any) => void;
+    /**
+     * Sets the Filter Builder Filter
+     * @param uFilter
+     */
+    setProps: (uFilter: IFUFlattenedFilter) => void;
+    /**
+     * Checks if two filter columns are the same.
+     * @param column1
+     * @param column2
+     * @returns True: Columns are equal; False: Columns are not equal
+     */
+    areColumnsEquals: (column1: IFUColumn, column2: IFUColumn) => boolean;
+    isResultPaginationEmpty: (resultObject: any) => boolean;
+}