@qrvey/utils 1.5.0-9 → 1.5.0

package/dist/filters/services/UChartPaginationApi.js

@@ -18,9 +18,7 @@ export default class UChartPaginationApi {
          * Gets afterKey object
          * @returns the afterKey object
          */
-        this.getAfterKey = () => {
-            return this.afterKey;
-        };
+        this.getAfterKey = () => this.afterKey;
         /**
          * Gets a promise with a resulting data
          * @param config the config
@@ -32,183 +30,14 @@ export default class UChartPaginationApi {
         this.getChartResult = (config, uFilter, filterLogic = [], chartSettings, resetApi = false) => {
             this.refineAfterkey(uFilter, resetApi);
             this.setProps(uFilter);
-            const requestBody = this._getPreviewRequestBody(uFilter, filterLogic, chartSettings, this.afterKey);
+            const requestBody = UChartPaginationApi._getPreviewRequestBody(uFilter, filterLogic, chartSettings, this.afterKey);
             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
                 .getResultsPagination(requestBody, false)
-                .then((response) => {
-                return this._getDataFromResponse(response, uFilter);
-            })
-                .catch((_) => {
-                return { data: [], total: 0 };
-            });
-        };
-        /**
-         * 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, afterKey) => {
-            const searchLogic = this._getSearchLogic(uFilter);
-            const filterCharts = this._getFilterCharts(uFilter, searchLogic, chartSettings);
-            const dimensions = !filterCharts[0]
-                ? this._getDimensionsBody(uFilter)
-                : this._getDimensionsBodyAdapter(filterCharts[0].dimensions);
-            const summaries = !filterCharts[0]
-                ? this._getSummariesBody(uFilter)
-                : filterCharts[0].summaries;
-            const maxDataPoints = this._getMaxDataPoints(uFilter.column, chartSettings);
-            const filters = [
-                ...filterLogic,
-                ...(!filterCharts[0] ? (searchLogic === null || searchLogic === void 0 ? void 0 : searchLogic.logic) || [] : []),
-            ];
-            return { dimensions, summaries, maxDataPoints, afterKey, logic: filters };
-        };
-        /**
-         * Gets dimension body structure
-         * @param uFilter The filter Builder filter
-         * @returns the dimension body structure
-         */
-        this._getDimensionsBody = (uFilter) => {
-            const { column, validator } = uFilter;
-            let dimensions;
-            if (!isRangeValidator(validator)) {
-                dimensions = [
-                    {
-                        questionid: column.id,
-                        type: column.type,
-                        formulaType: column.type === COLUMN.FORMULA ? column.formulaType : undefined,
-                        sort: this._getSortOption(column),
-                    },
-                ];
-                dimensions = this._refineBodies([...dimensions], uFilter);
-            }
-            return dimensions;
-        };
-        /**
-         * Get a dimension body structure foor pagination endpoint
-         * @param dimensions
-         * @returns the dimension body structure
-         */
-        this._getDimensionsBodyAdapter = (dimensions = []) => {
-            return dimensions.map((dimension) => ({
-                questionid: dimension.questionid,
-                type: dimension.type,
-                formulaType: dimension.type === COLUMN.FORMULA ? dimension.formulaType : undefined,
-                groupType: dimension.groupType,
-                groupValue: dimension.groupValue,
-                sort: {
-                    by: _get(dimension, "sortOption.sortBy", "VALUE"),
-                    direction: _get(dimension, "sortOption.sortDirection", "DESC"),
-                },
-            }));
-        };
-        /**
-         * 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 by = "CATEGORY";
-            let direction = isNumericalColumn(column) ? "DESC" : "ASC";
-            if (!isEmpty(column.sorting)) {
-                by = _get(column.sorting, "sortBy");
-                direction = _get(column.sorting, "order");
-                if (by == null)
-                    by = "VALUE";
-                if (direction == null)
-                    direction = "DESC";
-            }
-            return { by, direction };
-        };
-        /**
-         * 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;
-        };
-        /**
-         * 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;
-                }
-                else {
-                    return validator;
-                }
-            }
+                .then((response) => this._getDataFromResponse(response, uFilter))
+                .catch((_) => ({ data: [], total: 0 }));
         };
         /**
          * Gets the Data from preview Response
@@ -219,32 +48,19 @@ export default class UChartPaginationApi {
         this._getDataFromResponse = (response, uFilter) => {
             var _a;
             const data = { data: [], total: 0 };
-            if (!this.isResultPaginationEmpty(response)) {
+            if (!UChartPaginationApi.isResultPaginationEmpty(response)) {
                 const records = _get(response, "data");
                 data.data = isEmpty(uFilter.column.aggregate)
                     ? records.map((record) => ({
                         value: record.key.toString(),
                     }))
-                    : this._getResponseSummaries(records);
+                    : UChartPaginationApi._getResponseSummaries(records);
                 data.data = getUniqueArray(data.data, "value");
                 data.total = (_a = _get(response, "totalGroups", 0)) !== null && _a !== void 0 ? _a : 0;
                 this.setAfterKey(_get(response, "afterKey"));
             }
             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.summaries[0].toString();
-                value && values.push({ value });
-            });
-            return values;
-        };
         /**
          * Refines the afterKey object
          * @param props
@@ -253,7 +69,7 @@ export default class UChartPaginationApi {
             if (forceSet ||
                 _get(uFilter, "values[0].value", "") !==
                     _get(this.uFilter, "values[0].value", "") ||
-                !this.areColumnsEquals(uFilter.column, _get(this.uFilter, "column")) ||
+                !UChartPaginationApi.areColumnsEquals(uFilter.column, _get(this.uFilter, "column")) ||
                 uFilter.validator !== this.uFilter.validator ||
                 uFilter.property !== this.uFilter.property ||
                 uFilter.extras.scope !== this.uFilter.extras.scope)
@@ -273,35 +89,17 @@ export default class UChartPaginationApi {
         this.setProps = (uFilter) => {
             this.uFilter = cloneDeep(uFilter);
         };
-        /**
-         * Checks if two filter columns are the same.
-         * @param column1
-         * @param column2
-         * @returns True: Columns are equal; False: Columns are not equal
-         */
-        this.areColumnsEquals = (column1, column2) => {
-            if (isEmpty(column1) || isEmpty(column2))
-                return false;
-            return (column1.id === column2.id &&
-                column1.qrveyid === column2.qrveyid &&
-                column1.property === column2.property &&
-                column1.aggregate === column2.aggregate);
-        };
-        this.isResultPaginationEmpty = (resultObject) => {
-            const result = _get(resultObject, "data");
-            return isEmpty(result);
-        };
     }
     /**
      * Gets the filter object structure for the searching text
      * @param {IFUFlattenedFilter} uFilter The filter object
      * @returns the filter object structure
      */
-    _getSearchLogic(uFilter) {
+    static _getSearchLogic(uFilter) {
         let searchLogic;
         if (!isEmpty(uFilter.values)) {
             searchLogic = flatUIToOldLogic([
-                Object.assign(Object.assign({}, uFilter), { validator: this._getValidationType(uFilter.column, uFilter.validator), column: Object.assign({}, uFilter.column) }),
+                Object.assign(Object.assign({}, uFilter), { validator: UChartPaginationApi._getValidationType(uFilter.column, uFilter.validator), column: Object.assign({}, uFilter.column) }),
             ]);
         }
         return searchLogic;
@@ -313,7 +111,7 @@ export default class UChartPaginationApi {
      * @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;
@@ -332,3 +130,191 @@ export default class UChartPaginationApi {
         return filterCharts;
     }
 }
+/**
+ * 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
+ */
+UChartPaginationApi._getPreviewRequestBody = (uFilter, filterLogic = [], chartSettings, afterKey) => {
+    const searchLogic = UChartPaginationApi._getSearchLogic(uFilter);
+    const filterCharts = UChartPaginationApi._getFilterCharts(uFilter, searchLogic, chartSettings);
+    const dimensions = !filterCharts[0]
+        ? UChartPaginationApi._getDimensionsBody(uFilter)
+        : UChartPaginationApi._getDimensionsBodyAdapter(filterCharts[0].dimensions);
+    const summaries = !filterCharts[0]
+        ? UChartPaginationApi._getSummariesBody(uFilter)
+        : filterCharts[0].summaries;
+    const maxDataPoints = UChartPaginationApi._getMaxDataPoints(uFilter.column, chartSettings);
+    const filters = [
+        ...filterLogic,
+        ...(!filterCharts[0] ? (searchLogic === null || searchLogic === void 0 ? void 0 : searchLogic.logic) || [] : []),
+    ];
+    return { dimensions, summaries, maxDataPoints, afterKey, logic: filters };
+};
+/**
+ * Gets dimension body structure
+ * @param uFilter The filter Builder filter
+ * @returns the dimension body structure
+ */
+UChartPaginationApi._getDimensionsBody = (uFilter) => {
+    const { column, validator } = uFilter;
+    let dimensions;
+    if (!isRangeValidator(validator)) {
+        dimensions = [
+            {
+                questionid: column.id,
+                type: column.type,
+                formulaType: column.type === COLUMN.FORMULA ? column.formulaType : undefined,
+                sort: UChartPaginationApi._getSortOption(column),
+            },
+        ];
+        dimensions = UChartPaginationApi._refineBodies([...dimensions], uFilter);
+    }
+    return dimensions;
+};
+/**
+ * Get a dimension body structure foor pagination endpoint
+ * @param dimensions
+ * @returns the dimension body structure
+ */
+UChartPaginationApi._getDimensionsBodyAdapter = (dimensions = []) => dimensions.map((dimension) => ({
+    questionid: dimension.questionid,
+    type: dimension.type,
+    formulaType: dimension.type === COLUMN.FORMULA ? dimension.formulaType : undefined,
+    groupType: dimension.groupType,
+    groupValue: dimension.groupValue,
+    sort: {
+        by: _get(dimension, "sortOption.sortBy", "VALUE"),
+        direction: _get(dimension, "sortOption.sortDirection", "DESC"),
+    },
+}));
+/**
+ * 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
+ */
+UChartPaginationApi._getMaxDataPoints = (column, chartSettings) => !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
+ */
+UChartPaginationApi._getSortOption = (column) => {
+    let by = "CATEGORY";
+    let direction = isNumericalColumn(column) ? "DESC" : "ASC";
+    if (!isEmpty(column.sorting)) {
+        by = _get(column.sorting, "sortBy");
+        direction = _get(column.sorting, "order");
+        if (by == null)
+            by = "VALUE";
+        if (direction == null)
+            direction = "DESC";
+    }
+    return { by, direction };
+};
+/**
+ * Gets summaries body structure
+ * @param uFilter The filter Builder filter
+ * @returns summaries body structure
+ */
+UChartPaginationApi._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
+ */
+UChartPaginationApi._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;
+};
+/**
+ * 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
+ */
+UChartPaginationApi._getValidationType = (column, validator) => {
+    if (isDateColumn(column) ||
+        column.type === COLUMN.BUCKET ||
+        isNumericalColumn(column)) {
+        return FILTER_VALIDATOR.EQUALS;
+    }
+    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;
+    }
+    return validator;
+};
+/**
+ * Gets summaries from preview response
+ * @param records The data from preview response
+ * @param values The values from the preview response
+ * @returns the sumaries
+ */
+UChartPaginationApi._getResponseSummaries = (records, values = []) => {
+    records.forEach((record) => {
+        const value = record.summaries[0].toString();
+        value && values.push({ value });
+    });
+    return values;
+};
+/**
+ * Checks if two filter columns are the same.
+ * @param column1
+ * @param column2
+ * @returns True: Columns are equal; False: Columns are not equal
+ */
+UChartPaginationApi.areColumnsEquals = (column1, column2) => {
+    if (isEmpty(column1) || isEmpty(column2))
+        return false;
+    return (column1.id === column2.id &&
+        column1.qrveyid === column2.qrveyid &&
+        column1.property === column2.property &&
+        column1.aggregate === column2.aggregate);
+};
+UChartPaginationApi.isResultPaginationEmpty = (resultObject) => {
+    const result = _get(resultObject, "data");
+    return isEmpty(result);
+};

package/dist/format/duration/addDurationFormat.d.ts

@@ -1,4 +1,4 @@
-/**[TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)]
+/** [TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)]
  * "Convert a number of seconds to a human readable string."
  *
  * `addDurationFormat` is a function that takes a number, a format, an optional locale, and an optional

package/dist/format/duration/addDurationFormat.js

@@ -1,5 +1,5 @@
 import { DurationFormatter } from "./durationFormatter";
-/**[TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)]
+/** [TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)]
  * "Convert a number of seconds to a human readable string."
  *
  * `addDurationFormat` is a function that takes a number, a format, an optional locale, and an optional
@@ -14,6 +14,6 @@ import { DurationFormatter } from "./durationFormatter";
 export function addDurationFormat(number, format, locale, fractionDigits) {
     return new DurationFormatter({
         template: format,
-        options: { locale: locale, fractionDigits: fractionDigits },
+        options: { locale, fractionDigits },
     }).format(number);
 }

package/dist/format/duration/durationFormatter.d.ts

@@ -49,7 +49,7 @@ export declare class DurationFormatter {
      * @returns The template string with all instances of H replaced with h and all instances of D
      * replaced with d.
      */
-    private matchFormatsReplace;
+    private static matchFormatsReplace;
     /**
      * It sets the numberFactor to the value of the duration part that matches the unit.
      */

package/dist/format/duration/durationFormatter.js

@@ -73,7 +73,7 @@ export class DurationFormatter {
      * @param {string} template - The format template string.
      */
     setParts(template) {
-        this.template = this.matchFormatsReplace(template);
+        this.template = DurationFormatter.matchFormatsReplace(template);
         this.parts = this.parseFormatTemplate(template);
     }
     /**
@@ -82,7 +82,7 @@ export class DurationFormatter {
      * @returns The template string with all instances of H replaced with h and all instances of D
      * replaced with d.
      */
-    matchFormatsReplace(template) {
+    static matchFormatsReplace(template) {
         return isEmpty(template) ? template : template.replace(/H/g, "h");
     }
     /**
@@ -124,15 +124,16 @@ export class DurationFormatter {
             return undefined;
         if (isEmpty(number))
             return "";
-        number *= this.numberFactor;
+        let _number = number;
+        _number *= this.numberFactor;
         const durationParts = this.parts.reduce((store, part) => {
-            store[part.symbol] = Math.floor(number / part.ms);
-            number %= part.ms;
+            store[part.symbol] = Math.floor(_number / part.ms);
+            _number %= part.ms;
             return store;
         }, {});
         if (isEmpty(this.template))
             return this.valueFormatter
-                .format(number)
+                .format(_number)
                 .padStart(this.parts.length, "0");
         return this.template.replace(PARTS_REGEX, (match, $1) => {
             return $1 || this.formatValue(durationParts, match);