@qrvey/utils 1.5.0-0 → 1.5.0-11

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

@@ -20,13 +20,13 @@ export default class UChartApi {
      * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
      * @returns the request body structure
      */
-    private _getPreviewRequestBody;
+    private static _getPreviewRequestBody;
     /**
      * Gets the filter object structure for the searching text
      * @param {IFUFlattenedFilter} uFilter The filter object
      * @returns the filter object structure
      */
-    private _getSearchLogic;
+    private static _getSearchLogic;
     /**
      * Gets the filters from the chart settings
      * @param {IFUFlattenedFilter} uFilter The filter object
@@ -34,54 +34,54 @@ export default class UChartApi {
      * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
      * @returns the filters from the chart settings
      */
-    private _getFilterCharts;
+    private static _getFilterCharts;
     /**
      * 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;
+    private static _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;
+    private static _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;
+    private static _getMaxDataPoints;
     /**
      * Gets sort option structure
      * @param column The column to filter
      * @returns sort option structure
      */
-    private _getSortOption;
+    private static _getSortOption;
     /**
      * Gets summaries body structure
      * @param uFilter The filter Builder filter
      * @returns summaries body structure
      */
-    private _getSummariesBody;
+    private static _getSummariesBody;
     /**
      * Refines the body structure
      * @param bodies The body structure
      * @param uFilter The filter Builder filter
      * @returns the body structure
      */
-    private _refineBodies;
+    private static _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;
+    private static _getValidationType;
     /**
      * Gets the Data from preview Response
      * @param response The preview presponse
@@ -96,5 +96,5 @@ export default class UChartApi {
      * @returns the sumaries
      */
     private _getResponseSummaries;
-    private isResultEmpty;
+    private static isResultEmpty;
 }

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

@@ -27,179 +27,14 @@ class UChartApi {
          * @returns a promise with a resulting data
          */
         this.getChartResult = (config, uFilter, filterLogic = [], chartSettings, _resetApi = false) => {
-            const requestBody = this._getPreviewRequestBody(uFilter, filterLogic, chartSettings);
+            const requestBody = UChartApi._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 {IFUFlattenedFilter} uFilter The filter object
-         * @param {IFBLogic[]} filterLogic Additional filter logic to apply in the preview
-         * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
-         * @returns the request body structure
-         */
-        this._getPreviewRequestBody = (uFilter, filterLogic = [], chartSettings) => {
-            const searchLogic = this._getSearchLogic(uFilter);
-            const filterCharts = this._getFilterCharts(uFilter, searchLogic, chartSettings);
-            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: uFilter.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,
-                        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;
-                }
-            }
+                .then((response) => this._getDataFromResponse(response, uFilter))
+                .catch((_) => ({ data: [] }));
         };
         /**
          * Gets the Data from preview Response
@@ -219,7 +54,7 @@ class UChartApi {
                         { value: (0, get_1._get)(response, "[0].max") },
                     ];
             }
-            else if (!this.isResultEmpty(response)) {
+            else if (!UChartApi.isResultEmpty(response)) {
                 const records = (0, get_1._get)(response, "data");
                 data.data = (0, isEmpty_1.isEmpty)(uFilter.column.aggregate)
                     ? records.map((record) => ({
@@ -236,24 +71,16 @@ class UChartApi {
          * @returns the sumaries
          */
         this._getResponseSummaries = (records, values = []) => {
+            let _values = values;
             records.forEach((record) => {
                 const value = record.summary[0].toString();
                 if (Array.isArray(record.items) && record.items.length)
-                    values = this._getResponseSummaries(record.items, values);
+                    _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 });
+                    !(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;
+            return _values;
         };
     }
     /**
@@ -261,11 +88,11 @@ class UChartApi {
      * @param {IFUFlattenedFilter} uFilter The filter object
      * @returns the filter object structure
      */
-    _getSearchLogic(uFilter) {
+    static _getSearchLogic(uFilter) {
         let searchLogic;
         if (!(0, isEmpty_1.isEmpty)(uFilter.values)) {
             searchLogic = (0, flatUIToOldLogic_1.flatUIToOldLogic)([
-                Object.assign(Object.assign({}, uFilter), { validator: this._getValidationType(uFilter.column, uFilter.validator), column: Object.assign({}, uFilter.column) }),
+                Object.assign(Object.assign({}, uFilter), { validator: UChartApi._getValidationType(uFilter.column, uFilter.validator), column: Object.assign({}, uFilter.column) }),
             ]);
         }
         return searchLogic;
@@ -277,7 +104,7 @@ class UChartApi {
      * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
      * @returns the filters from the chart settings
      */
-    _getFilterCharts(uFilter, searchLogic, chartSettings) {
+    static _getFilterCharts(uFilter, searchLogic, chartSettings) {
         let filterCharts = [];
         const haveAggFilters = ((chartSettings === null || chartSettings === void 0 ? void 0 : chartSettings.aggregateColumns) || []).length &&
             ((chartSettings === null || chartSettings === void 0 ? void 0 : chartSettings.chart) || []).length;
@@ -297,3 +124,167 @@ class UChartApi {
     }
 }
 exports.default = UChartApi;
+/**
+ * Gets request body structure
+ * @param {IFUFlattenedFilter} uFilter The filter object
+ * @param {IFBLogic[]} filterLogic Additional filter logic to apply in the preview
+ * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
+ * @returns the request body structure
+ */
+UChartApi._getPreviewRequestBody = (uFilter, filterLogic = [], chartSettings) => {
+    const searchLogic = UChartApi._getSearchLogic(uFilter);
+    const filterCharts = UChartApi._getFilterCharts(uFilter, searchLogic, chartSettings);
+    const chartsBody = !filterCharts[0]
+        ? [UChartApi._getChartBody(uFilter)]
+        : [filterCharts[0]];
+    const filters = [
+        ...filterLogic,
+        ...(!filterCharts[0] ? (searchLogic === null || searchLogic === void 0 ? void 0 : searchLogic.logic) || [] : []),
+    ];
+    return {
+        charts: chartsBody,
+        logic: filters,
+        qrveyid: uFilter.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
+ */
+UChartApi._getChartBody = (uFilter, chartSettings) => {
+    const dimensions = UChartApi._getDimensionsBody(uFilter, chartSettings);
+    const summaries = UChartApi._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
+ */
+UChartApi._getDimensionsBody = (uFilter, chartSettings) => {
+    const { column, validator } = uFilter;
+    let dimensions;
+    if (!(0, isRangeValidator_1.isRangeValidator)(validator)) {
+        dimensions = [
+            {
+                questionid: column.id,
+                qrveyid: column.qrveyid,
+                maxDataPoints: UChartApi._getMaxDataPoints(column, chartSettings),
+                type: column.type,
+                formulaType: column.type === "FORMULA" ? column.formulaType : undefined,
+                sortOption: UChartApi._getSortOption(column),
+            },
+        ];
+        dimensions = UChartApi._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
+ */
+UChartApi._getMaxDataPoints = (column, chartSettings) => !(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
+ */
+UChartApi._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
+ */
+UChartApi._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
+ */
+UChartApi._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
+ */
+UChartApi._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;
+    }
+    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;
+    }
+    return validator;
+};
+UChartApi.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;
+};

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

@@ -28,13 +28,13 @@ export default class UChartPaginationApi {
      * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
      * @returns the request body structure
      */
-    private _getPreviewRequestBody;
+    private static _getPreviewRequestBody;
     /**
      * Gets the filter object structure for the searching text
      * @param {IFUFlattenedFilter} uFilter The filter object
      * @returns the filter object structure
      */
-    private _getSearchLogic;
+    private static _getSearchLogic;
     /**
      * Gets the filters from the chart settings
      * @param {IFUFlattenedFilter} uFilter The filter object
@@ -42,52 +42,52 @@ export default class UChartPaginationApi {
      * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
      * @returns the filters from the chart settings
      */
-    private _getFilterCharts;
+    private static _getFilterCharts;
     /**
      * Gets dimension body structure
      * @param uFilter The filter Builder filter
      * @returns the dimension body structure
      */
-    private _getDimensionsBody;
+    private static _getDimensionsBody;
     /**
      * Get a dimension body structure foor pagination endpoint
      * @param dimensions
      * @returns the dimension body structure
      */
-    private _getDimensionsBodyAdapter;
+    private static _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;
+    private static _getMaxDataPoints;
     /**
      * Gets sort option structure
      * @param column The column to filter
      * @returns sort option structure
      */
-    private _getSortOption;
+    private static _getSortOption;
     /**
      * Gets summaries body structure
      * @param uFilter The filter Builder filter
      * @returns summaries body structure
      */
-    private _getSummariesBody;
+    private static _getSummariesBody;
     /**
      * Refines the body structure
      * @param bodies The body structure
      * @param uFilter The filter Builder filter
      * @returns the body structure
      */
-    private _refineBodies;
+    private static _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;
+    private static _getValidationType;
     /**
      * Gets the Data from preview Response
      * @param response The preview presponse
@@ -101,7 +101,7 @@ export default class UChartPaginationApi {
      * @param values The values from the preview response
      * @returns the sumaries
      */
-    private _getResponseSummaries;
+    private static _getResponseSummaries;
     /**
      * Refines the afterKey object
      * @param props
@@ -123,6 +123,6 @@ export default class UChartPaginationApi {
      * @param column2
      * @returns True: Columns are equal; False: Columns are not equal
      */
-    areColumnsEquals: (column1: IFUColumn, column2: IFUColumn) => boolean;
-    isResultPaginationEmpty: (resultObject: any) => boolean;
+    static areColumnsEquals: (column1: IFUColumn, column2: IFUColumn) => boolean;
+    static isResultPaginationEmpty: (resultObject: any) => boolean;
 }