@qrvey/utils 1.3.1 → 1.4.0-0

package/src/filters/services/UChartPaginationApi.ts

@@ -1,326 +0,0 @@
-import { isNumericalColumn } from "../../columns/helpers/isNumericalColumn";
-import { isDateColumn } from "../../columns/helpers/isDateColumn";
-import { getAggFilters } from "../helpers/OLD_getAggFilters";
-import { IFBData } from "../interfaces/backend/IFBData";
-import { IFSValue } from "../interfaces/common/IFSValue";
-import ChartsApi from "../../services/api/Charts.api";
-import { isRangeValidator } from "../helpers/common/isRangeValidator";
-import { getUniqueArray } from "../../general/array/getUniqueArray";
-import { IFilterConfig } from "../interfaces/common/IFilterConfig";
-import { IFUFlattenedFilter } from "../interfaces/ui/IFUFlattenedFilter";
-import { IFBLogic } from "../interfaces/backend/IFBLogic";
-import { isEmpty } from "../../general/mix/isEmpty";
-import { IFUChartSettings } from "../interfaces/ui/IFUChartSettings";
-import { OLD_IFilterData } from "../interfaces/OLD_IFilterData";
-import { getAggFiltersBySummaryIndex } from "../helpers/backend/getAggFiltersBySummaryIndex";
-import { COLUMN } from "../../columns/constants/COLUMN";
-import { _get } from "../../general/object/get";
-import { IFUColumn } from "../interfaces/ui/IFUColumn";
-import { AGGREGATE } from "../../charts/constants/AGGREGATE";
-import { cloneDeep } from "../../general/object/cloneDeep";
-import { FILTER_VALIDATOR } from "../constants/common/FILTER_VALIDATOR";
-import { IFValidator } from "../interfaces/IFValidator";
-import { flatUIToOldLogic } from '../adapters/flatUIToOldLogic';
-
-export default class UChartPaginationApi {
-
-    afterKey: any;
-    uFilter: IFUFlattenedFilter;
-
-    /**
-     * Gets afterKey object
-     * @returns the afterKey object
-     */
-    getAfterKey = (): any => {
-        return this.afterKey;
-    };
-
-    /**
-     * 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 = false): Promise<IFBData> => {
-        this.refineAfterkey(uFilter, resetApi);
-        this.setProps(uFilter);
-
-        const requestBody = this._getPreviewRequestBody(uFilter, filterLogic, chartSettings, this.afterKey);
-        const customChartApi = new ChartsApi({ ...config, qrvey_id: isEmpty(uFilter.column.aggregate) ? uFilter.column.qrveyid : chartSettings?.qrveyid });
-        return customChartApi.getResultsPagination(requestBody, false).then(response => {
-          return this._getDataFromResponse(response, uFilter);
-        }).catch(_ => {
-          return { data: [], total: 0 };
-        });
-    };
-
-    /**
-     * 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 = (uFilter: IFUFlattenedFilter, filterLogic: IFBLogic[] = [], chartSettings?: IFUChartSettings, afterKey?: any) => {
-        const { column, validator } = uFilter;
-        const haveAggFilters = (chartSettings?.aggregateColumns || []).length && (chartSettings?.chart || []).length;
-        let searchLogic: OLD_IFilterData;
-        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 => {
-                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 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(column, chartSettings);
-
-        const filters = [
-          ...filterLogic,
-          ...!filterCharts[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
-     */
-    private _getDimensionsBody = (uFilter: IFUFlattenedFilter) => {
-        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
-     */
-    private _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
-     */
-    private _getMaxDataPoints = (column: IFUColumn, chartSettings?: IFUChartSettings) => {
-        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
-     */
-    private _getSortOption = (column: IFUColumn) => {
-        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
-     */
-    private _getSummariesBody = (uFilter: IFUFlattenedFilter) => {
-        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 = [
-            { ...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
-     */
-    private _refineBodies = (bodies: any[], uFilter: IFUFlattenedFilter) => {
-        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
-     */
-    private _getValidationType = (column: IFUColumn, validator: IFValidator): IFValidator => {
-        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;
-            }
-        }
-    };
-
-    /**
-     * Gets the Data from preview Response
-     * @param response The preview presponse
-     * @param uFilter The filter Builder filter
-     * @returns The resulting data
-     */
-    private _getDataFromResponse = (response: any, uFilter: IFUFlattenedFilter): IFBData => {
-        const data = { data: [], total: 0 };
-        if (!this.isResultPaginationEmpty(response)) {
-            const records = _get(response, 'data');
-            data.data = isEmpty(uFilter.column.aggregate)
-                ? records.map(record => ({
-                value: record.key.toString()
-                }))
-                : this._getResponseSummaries(records);
-
-            data.data = getUniqueArray(data.data, 'value');
-            data.total = _get(response, 'totalGroups', 0) ?? 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
-     */
-    private _getResponseSummaries = (records: any[], values: IFSValue[] = []): IFSValue[] => {
-        records.forEach(record => {
-            const value = record.summaries[0].toString();
-            value && values.push({ value });
-        });
-        return values;
-    };
-
-    /**
-     * Refines the afterKey object
-     * @param props 
-     */
-    private refineAfterkey = (uFilter: IFUFlattenedFilter, forceSet = false): void => {
-        if (forceSet
-            || _get(uFilter, 'values[0].value', '') !==  _get(this.uFilter, 'values[0].value', '')
-            || !this.areColumnsEquals(uFilter.column, _get(this.uFilter, 'column'))
-            || uFilter.validator !== this.uFilter.validator
-            || uFilter.property !== this.uFilter.property
-            || uFilter.extras.scope !== this.uFilter.extras.scope
-        ) this.setAfterKey(undefined);
-    };
-
-    /**
-     * Sets the afterKey object
-     * @param afterKey the afterKey object
-     */
-    setAfterKey = (afterKey: any): void => {
-        this.afterKey = afterKey;
-    };
-
-    /**
-     * Sets the Filter Builder Filter
-     * @param uFilter
-     */
-    setProps = (uFilter: IFUFlattenedFilter): void => {
-        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
-     */
-    areColumnsEquals = (column1: IFUColumn, column2: IFUColumn): boolean => {
-        if (isEmpty(column1) || isEmpty(column2)) return false;
-
-        return column1.id === column2.id &&
-            column1.qrveyid === column2.qrveyid &&
-            column1.property === column2.property &&
-            column1.aggregate === column2.aggregate;
-    };
-
-    isResultPaginationEmpty = (resultObject): boolean => {
-        const result = _get(resultObject, 'data');
-        return isEmpty(result);
-      };
-      
-}

package/src/filters/services/index.ts

@@ -1,3 +0,0 @@
-export * from './Filters.api';
-export * from './UChartApi';
-export * from './UChartPaginationApi';

package/src/format/definition.ts

@@ -1,107 +0,0 @@
-
-import { COLUMN } from '../columns/constants/COLUMN';
-import { CHART_TYPE } from '../constants/Charts.Const';
-import { ChartType } from '../interfaces/Chart.Interface';
-
-export const textFields: string[] = [COLUMN.TEXTFIELD, COLUMN.TEXT_CATEGORY, COLUMN.TEXT_LABEL, COLUMN.TEXT_CATEGORY];
-
-export const complexFields: string[] = [COLUMN.USADDRESS, COLUMN.ADDRESS, COLUMN.NAME, COLUMN.TEXTFIELD, COLUMN.LONGTEXT, COLUMN.FILEUPLOAD, COLUMN.IMAGEUPLOAD];
-
-export const numericalFields: string[] = [COLUMN.SLIDEBAR, COLUMN.NUMERIC, COLUMN.RATING];
-
-export const QUESTION_FORMAT_SUPPORT = [
-    COLUMN.DATE,
-    COLUMN.NUMERIC,
-    COLUMN.FILEUPLOAD,
-    COLUMN.IMAGEUPLOAD,
-    // COLUMN.RANKING,
-    COLUMN.RATING,
-    COLUMN.SLIDEBAR,
-    COLUMN.YES_NO,
-    COLUMN.PHONE,
-    COLUMN.SINGLE_CHOICE,
-    COLUMN.LONGTEXT,
-    COLUMN.DROPDOWN,
-    COLUMN.EXPRESSION,
-    COLUMN.NAME,
-    COLUMN.EMAIL_FORM,
-    COLUMN.IMAGE,
-    COLUMN.TEXT_LABEL
-  ];
-export const DATEGROUP_FORMATTING_UNSUPPORT = ['YEAR', 'QUARTER', 'MONTH', 'WEEK'];
-
-export const appliesFormatting = (columnType): boolean => QUESTION_FORMAT_SUPPORT.includes(columnType);
-
-export const hasfileSizeProperty = (column: any = {}): boolean => isComplexColumn(column) && column.property && (column.property.value || column.property).includes('fileSize');
-
-export const isComplexColumn = (column: any = {}): boolean => complexFields.includes(column.type);
-
-export const isNumericalColumn = (column: any = {}): boolean => numericalFields.includes(column.type) || column.formulaType === 'number';
-
-export function supportNumericFormatting(chartType: ChartType): boolean {
-    const supportedCharts = [
-      CHART_TYPE.TABLE_CHART,
-      CHART_TYPE.CROSSTAB_CHART,
-      CHART_TYPE.BAR_CHART,
-      CHART_TYPE.LINE_CHART,
-      CHART_TYPE.SYMBOL_CHART,
-      CHART_TYPE.MINMAX_CHART,
-      CHART_TYPE.BAR_CHART_MS,
-      CHART_TYPE.LINE_CHART_MS,
-      CHART_TYPE.SYMBOL_CHART_MS,
-      CHART_TYPE.COMBO_CHART
-    ];
-    return supportedCharts.includes(chartType);
-  }
-
-export const isTextColumn = (column: any): boolean => textFields.includes(column.type) || column.formulaType === 'string' || column.formulaType === 'boolean';
-
-export const currencyISO = [
-  { text: 'Default', label: 'USD' },
-  { text: '$ (USD)', label: 'USD' },
-  { text: '€ (EUR)', label: 'EUR' },
-  { text: '¥ (JPY)', label: 'JPY' },
-  { text: '£ (GBP)', label: 'GBP' },
-  { text: '₩ (WON)', label: 'WON' },
-  { text: '$ (AUD)', label: 'AUD' },
-  { text: '$ (CAD)', label: 'CAD' },
-  { text: 'CHF (CHF)', label: 'CHF' },
-  { text: '¥ (CNY)', label: 'CNY' },
-  { text: 'kr (SEK)', label: 'SEK' },
-  { text: '$ (MXN)', label: 'MXN' },
-  { text: '$ (NZD)', label: 'NZD' },
-  { text: '$ (SGD)', label: 'SGD' },
-  { text: '$ (HKD)', label: 'HKD' },
-  { text: 'kr (NOK)', label: 'NOK' },
-  { text: '₩ (KRW)', label: 'KRW' },
-  { text: '₺ (TRY)', label: 'TRY' },
-  { text: '₹ (INR)', label: 'INR' },
-  { text: '₽ (RUB)', label: 'RUB' },
-  { text: 'R$ (BRL)', label: 'BRL' },
-  { text: 'R (ZAR)', label: 'ZAR' },
-  { text: 'kr (DKK)', label: 'DKK' },
-  { text: 'zł (PLN)', label: 'PLN' },
-  { text: 'NT$ (TWD)', label: 'TWD' },
-  { text: '฿ (THB)', label: 'THB' },
-  { text: 'RM (MYR)', label: 'MYR' }
-];
-
-export const enum LOCALE_FORMATS {
-  DECIMAL = 'Decimal',
-  CURRENCY = 'Currency',
-  PERCENTAGE = 'Percentage',
-  SCIENTIFIC = 'Scientific',
-  ABBREVIATED = 'Abbreviated'
-}
-export const enum LOCALE_STYLES {
-  DECIMAL = 'decimal',
-  PERCENT = 'percent',
-  CURRENCY = 'currency',
-  SCIENTIFIC = 'scientific',
-  COMPACT = 'compact'
-}
-
-export const LANG_DEFAULT = 'en-US';
-export const CURRENCY_DEFAULT = { text: '$ (USD)', label: 'USD' };
-export const DATETIME_OPTIONS = { year: 'numeric', month: 'numeric', day: 'numeric', hour: 'numeric', minute: 'numeric', second: 'numeric' };
-