@qrvey/utils 1.3.3 → 1.4.0-2

package/src/filters/adapters/UIToFlatUI.ts

@@ -1,108 +0,0 @@
-import { IDataset } from "../../qrvey/interfaces/IDataset";
-import { IFUFlattenedFilter } from "../interfaces/ui/IFUFlattenedFilter";
-import { IFUData } from "../interfaces/ui/IFUData";
-import { adaptDateGroupingProperty } from "./adaptDateGroupingProperty";
-import { adaptFilterValues } from "./adaptFilterValues";
-import { isEmpty } from "../../general/mix/isEmpty";
-import { cloneDeep } from "../../general/object/cloneDeep";
-import { IFUScope } from "../interfaces/ui/IFUScope";
-import { IColumn } from "../../columns/interfaces/IColumn";
-
-/**
- * Generates a Flattened UI filter structure from UI Filter Data structure.
- * @param filterData The UI filter data object.
- * @param datasetsInfo Collection of datasets information. Optional for updating the datasets info
- * @returns a flattened UI filters array
- */
- export function UIToFlatUI(filterData: IFUData, datasetsInfo: IDataset[] = []): IFUFlattenedFilter[] {
-    let uFilters: IFUFlattenedFilter[] = [];
-    if (isEmpty(filterData) || isEmpty(filterData.scopes) || filterData.scopes.length === 0) return uFilters;
-    filterData = cloneDeep(filterData);
-
-    switch (filterData.version) {
-        case '2.1': {
-            uFilters = UI21ToFlatUI(filterData.scopes, datasetsInfo);
-            break;
-        }
-    }
-    return uFilters;
-}
-
-/**
- * Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
- * @param scopes The filter scope section
- * @returns a flattened UI filters array
- */
-function UI21ToFlatUI(scopes: IFUScope[] = [], datasetsInfo: IDataset[] = []): IFUFlattenedFilter[] {
-    const uFilters: IFUFlattenedFilter[] = [];
-    if (scopes.length === 0) return uFilters;
-    scopes.forEach(scope => {
-        if (scope.datasets.length > 0) {
-            scope.datasets.forEach(dataset => {
-                if (dataset.filters.length > 0) {
-                    dataset.filters.forEach(filter => {
-                        const datasetInfo: IDataset = datasetsInfo.find(dInfo => dInfo.qrveyid === dataset.qrveyid && dInfo.linkid === dataset.linkid);
-                        let columnInfo: IColumn;
-                        if (!isEmpty(datasetInfo)) columnInfo = datasetInfo.options.find(cInfo => cInfo.id === filter.column.id && cInfo.qrveyid === filter.column.qrveyid && cInfo.linkid === filter.column.linkid);
-                        const info = !isEmpty(filter.extras.info) ? { icon: filter.extras.info.icon, label: filter.extras.info.label } : undefined;
-                        const property = adaptDateGroupingProperty(filter.property);
-
-                        const uFilter: IFUFlattenedFilter = {
-                            collapsed: filter.collapsed,
-                            column: {
-                                id: filter.column.id,
-                                formulaType: filter.column.formulaType,
-                                qrveyid: filter.column.qrveyid,
-                                aggregate: filter.column.aggregate,
-                                calculation: filter.column.calculation,
-                                label: columnInfo?.label || filter.column.label,
-                                linkid: filter.column.linkid,
-                                linked: filter.column.linked,
-                                outputFormat: filter.column.outputFormat,
-                                type: filter.column.type,
-                            },
-                            dateSection: filter.dateSection,
-                            displayed: filter.displayed,
-                            enabled: filter.enabled,
-                            extras: {
-                                ...filter.extras,
-                                panelid: filter.extras.panelid,
-                                filterLabel: filter.extras.filterLabel,
-                                info,
-                                scope: filter.extras.scope,
-                                scopeid: filter.extras.scopeid,
-                                section: filter.extras.section,
-                                scopeInfo: {
-                                    collapsed: scope.collapsed,
-                                    enabled: scope.enabled,
-                                    displayed: scope.displayed,
-                                    label: scope.label,
-                                    scope: scope.scope,
-                                    scopeid: scope.scopeid,
-                                },
-                                dataset: {
-                                    qrveyid: dataset.qrveyid,
-                                    collapsed: dataset.collapsed,
-                                    enabled: dataset.enabled,
-                                    displayed: dataset.enabled,
-                                    label: dataset.label,
-                                    linkid: dataset.linkid,
-                                },
-                            },
-                            filterid: filter.filterid,
-                            lookupDisplayIndex: filter.lookupDisplayIndex,
-                            nullValues: filter.nullValues,
-                            operator: filter.operator,
-                            property,
-                            selectAll: filter.selectAll,
-                            validator: filter.validator,
-                            values: adaptFilterValues(filter),
-                        };
-                        uFilters.push(uFilter);
-                    });
-                }
-            });
-        }
-    });
-    return uFilters;
-}

package/src/filters/adapters/UIToOldLogic.ts

@@ -1,170 +0,0 @@
-import { adaptDateGroupingProperty } from "./adaptDateGroupingProperty";
-import { FILTER_OPERATOR } from "../constants/common/FILTER_OPERATOR";
-import { adaptFilterValues } from "./adaptFilterValues";
-import { flatUIToOldLogic } from "./flatUIToOldLogic";
-import { UIToFlatUI } from "./UIToFlatUI";
-import { IFUData } from "../interfaces/ui/IFUData";
-import { OLD_IFilterData } from "../interfaces/OLD_IFilterData";
-import { isEmpty } from "../../general/mix/isEmpty";
-import { cloneDeep } from "../../general/object/cloneDeep";
-import { IFUScope } from "../interfaces/ui/IFUScope";
-import { IFSection } from "../interfaces/IFSection";
-import { OLD_IFilterLogic } from "../interfaces/OLD_IFilterLogic";
-import { IFUDataset } from "../interfaces/ui/IFUDataset";
-import { OLD_IFilterFilters } from "../interfaces/OLD_IFilterFilters";
-import { IFUFilter } from "../interfaces/ui/IFUFilter";
-import { OLD_IFilterExpression } from "../interfaces/OLD_IFilterExpression";
-import { getBackendGroupValue } from "../helpers/backend/getBackendGroupValue";
-import { getBackendProperty } from "../helpers/backend/getBackendProperty";
-import { getBackendValidator } from "../helpers/backend/getBackendValidator";
-import { getBackendValues } from "../helpers/backend/getBackendValues";
-import { OLD_IFilterDetail } from "../interfaces/OLD_IFilterDetail";
-import { getUIValues } from "../helpers/ui/getUIValues";
-
-export function UIToOldLogic(uFilterData: IFUData, flattedMethod = true): OLD_IFilterData {
-    let oldFilterData: OLD_IFilterData;
-    if (isEmpty(uFilterData) || isEmpty(uFilterData.scopes)) return oldFilterData;
-    uFilterData = cloneDeep(uFilterData);
-
-    switch (uFilterData.version) {
-        case '2.1': {
-            oldFilterData = flattedMethod ? flatUIToOldLogic(UIToFlatUI(uFilterData), uFilterData.section) : UI21ToOldLogic(uFilterData);
-            break;
-        }
-    }
-    return oldFilterData;
-}
-
-function UI21ToOldLogic(uFilterData: IFUData): OLD_IFilterData {
-    return {
-        collapsed: false,
-        enabled: true,
-        section: uFilterData.section,
-        logic: buildLogics(uFilterData.scopes, uFilterData.section),
-    };
-}
-
-function buildLogics(scopeSection: IFUScope[], section: IFSection): OLD_IFilterLogic[] {
-    return scopeSection.reduce((logics: OLD_IFilterLogic[], scope: IFUScope) => {
-        const logic: OLD_IFilterLogic = {
-            enabled: scope.enabled,
-            filters: buildFilters(scope.datasets, scope),
-            scope: scope.scope,
-            uiExtras: {
-                scopeid: scope.scopeid,
-                collapsed: scope.collapsed,
-                section: section
-            }
-        };
-        logics.push(logic);
-        return logics;
-    }, [] as OLD_IFilterLogic[]);
-}
-
-function buildFilters(datasetSection: IFUDataset[], scope: IFUScope): OLD_IFilterFilters[] {
-    return datasetSection.reduce((filters: OLD_IFilterFilters[], dataset: IFUDataset) => {
-        const filter: OLD_IFilterFilters = {
-            expressions: [{
-                expressions: buildExpressions(dataset.filters, scope, dataset),
-                operator: FILTER_OPERATOR.OR,
-                uiExtras: {
-                    expressionid: '' // CANNOT ADD AT THIS SCOPE.
-                }
-            }] as OLD_IFilterFilters[],
-            operator: FILTER_OPERATOR.AND
-        };
-        filters.push(filter);
-        return filters;
-    }, [] as OLD_IFilterFilters[]);
-}
-
-function buildExpressions(filterSection: IFUFilter[], scope: IFUScope, dataset: IFUDataset): OLD_IFilterExpression[] {
-    return filterSection.reduce((expressions: OLD_IFilterExpression[], filter: IFUFilter) => {
-        const expression: OLD_IFilterExpression = {
-            enabled: filter.enabled,
-            formulaType: filter.column.formulaType,
-            groupValue: getBackendGroupValue(filter),
-            linkid: filter.column.linkid,
-            property: getBackendProperty(filter),
-            qrveyid: filter.column.qrveyid,
-            questionType: filter.column.type,
-            questionid: filter.column.id,
-            validationType: getBackendValidator(filter),
-            value: getBackendValues(filter),
-            uiExtras: getFilterDetail(filter, scope, dataset),
-        };
-        expression['enabled'] = filter.selectAll || expression.value?.length > 0 ? filter.enabled : false;
-
-        expressions.push(expression);
-        return expressions;
-    }, [] as OLD_IFilterExpression[]);
-}
-
-const getFilterDetail = (filter: IFUFilter, scope: IFUScope, dataset: IFUDataset): OLD_IFilterDetail => {
-    // let aggregate, calculation, info;
-    let info;
-    // if (filter.column.aggregate != null) {
-    //     aggregate = {
-    //         abbreviation: undefined, // CANNOT ADD AT THIS SCOPE
-    //         id: undefined, // CANNOT ADD AT THIS SCOPE
-    //         label: filter.column.aggregate,
-    //         text: undefined, // CANNOT ADD AT THIS SCOPE
-    //     };
-    // }
-    // if (filter.column.calculation != null) {
-    //     calculation = {
-    //         abbreviation: undefined, // CANNOT ADD AT THIS SCOPE
-    //         id: undefined, // CANNOT ADD AT THIS SCOPE
-    //         text: undefined,
-    //         type: undefined,
-    //         value: filter.column.calculation,
-    //     };
-    // }
-    if (!isEmpty(filter.extras.info)) {
-        info = {
-            icon: filter.extras.info.icon,
-            label: filter.extras.info.label,
-        };
-    }
-    const property = adaptDateGroupingProperty(filter.property);
-
-    return {
-        collapsed: filter.collapsed,
-        column: {
-            dataset: {
-                label: dataset.label,
-                qrveyid: dataset.qrveyid,
-            },
-            id: filter.column.id,
-            qrveyid: filter.column.qrveyid,
-            text: filter.column.label,
-            type: filter.column.type,
-            aggregate: filter.column.aggregate,
-            calculation: filter.column.calculation,
-            formulaType: filter.column.formulaType,
-            linked: undefined,
-            linkid: filter.column.linkid,
-            outputFormat: filter.column.outputFormat,
-            property: filter.column.property,
-            sorting: filter.column.sorting,
-        },
-        dateSection: filter.dateSection,
-        enabled: filter.enabled,
-        extras: filter.extras,
-        info,
-        lookupDisplayIndex: filter.lookupDisplayIndex,
-        nullValues: filter.nullValues,
-        operator: filter.operator,
-        property,
-        scope: scope.scope,
-        scopeid: filter.extras.scopeid,
-        scopeEnabled: scope.enabled,
-        panelid: filter.extras.panelid,
-        panelName: filter.extras.filterLabel,
-        section: filter.extras.section,
-        selectAll: filter.selectAll,
-        uiValue: getUIValues(filter, { addEnableds: true } ),
-        validator: filter.validator,
-        values: adaptFilterValues(filter)
-    };
-};

package/src/filters/adapters/adaptDateGroupingProperty.ts

@@ -1,19 +0,0 @@
-import { IFProperty } from "../interfaces/IFProperty";
-import { DATE_DISTINCT_PROPERTY } from "../../dates/constants/DATE_DISTINCT_PROPERTY";
-import { DATE_DISTINCT_TIME_PROPERTY } from "../../dates/constants/DATE_DISTINCT_TIME_PROPERTY";
-
-/**
- * [TODO: For 2022, eliminate this adapter]
- * Get the new property base on the old date grouping properties
- * @param property the property to be adapted
- * @returns a adapted property
- */
-export function adaptDateGroupingProperty(property: IFProperty | any): IFProperty {
-    return property === 'p&quarter' ? DATE_DISTINCT_PROPERTY.YEAR_QUARTER :
-        property === 'p&month' ? DATE_DISTINCT_PROPERTY.YEAR_MONTH :
-            property === 'p&day' ? DATE_DISTINCT_PROPERTY.MONTH_DAY :
-                property === 'p&hour' ? DATE_DISTINCT_TIME_PROPERTY.DAY_HOUR :
-                    property === 'p&minute' ? DATE_DISTINCT_TIME_PROPERTY.HOUR_MINUTE :
-                        property === 'p&second' ? DATE_DISTINCT_TIME_PROPERTY.MINUTE_SECOND :
-                            property;
-}

package/src/filters/adapters/adaptFilterData.ts

@@ -1,31 +0,0 @@
-import { IFUData } from "../interfaces/ui/IFUData";
-import { IFSData } from "../interfaces/common/IFSData";
-import { OLD_IFilterData } from "../interfaces/OLD_IFilterData";
-import { IDataset } from "../../qrvey/interfaces/IDataset";
-import { isEmpty } from "../../general/mix/isEmpty";
-import { cloneDeep } from "../../general/object/cloneDeep";
-import { _get } from "../../general/object/get";
-import { logicToUI } from "./logicToUI";
-import { FDToUI } from "./FDToUI";
-import { UIToFD } from "./UIToFD";
-import { logicToFD } from "./logicToFD";
-
-
-/**
- * Checks and adapts the v2.0 Filter Data Structure to the v2.1
- * @param filterData The filter data structure. Accepts both v2.1 or v2.0
- * @param getUIFilterData Flag to get a Filter Data (False) or the UI Filter Data (True)
- * @param datasetsInfo Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory
- * @returns A new filter data structure v2.1
- */
-export function adaptFilterData(filterData: IFSData | IFUData | OLD_IFilterData, getUIFilterData = true, datasetsInfo: IDataset[] = []): IFSData | IFUData {
-    if (isEmpty(filterData)) return;
-    filterData = cloneDeep(filterData);
-
-    if (!isEmpty(_get(filterData, 'logic'))) {
-        return getUIFilterData ? logicToUI(_get(filterData, 'logic'), _get(filterData, 'section'), _get(filterData, 'enabled')) : logicToFD(_get(filterData, 'logic'), _get(filterData, 'section'), _get(filterData, 'enabled'));
-    }
-    if (!isEmpty(_get(filterData, 'scopes'))) {
-        return getUIFilterData ? FDToUI(filterData as IFSData, datasetsInfo) : UIToFD(filterData as IFUData);
-    }
-}

package/src/filters/adapters/adaptFilterValues.ts

@@ -1,24 +0,0 @@
-import { IFValue } from "../interfaces/IFValue";
-import { IFSFilter } from "../interfaces/common/IFSFilter";
-import { isEmpty } from "../../general/mix/isEmpty";
-import { COLUMN } from "../../columns/constants/COLUMN";
-import { IFSValueRanking } from "../interfaces/common/IFSValueRanking";
-import { IFSValue } from "../interfaces/common/IFSValue";
-import { IFSValueRange } from "../interfaces/common/IFSValueRange";
-import { IFSValueRelativeDate } from "../interfaces/common/IFSValueRelativeDate";
-
-
-/**
- * [TODO: For 2022, eliminate this adapter]
- * Gets an adapted filter value array. Validates the enabled property and sets
- * @param filter The filter
- * @returns A new value array with the filled properties.
- */
-export function adaptFilterValues(filter: IFSFilter): IFValue[] {
-    const setValue = value => ({ ...value, value: isEmpty(value.value) ? undefined : value.value, displayed: isEmpty(value.displayed) ? true : value.displayed, enabled: isEmpty(value.enabled) ? true : value.enabled });
-
-    if (filter.column.type === COLUMN.RANKING && isEmpty(filter.column.aggregate)) {
-        return ((filter.values || []) as IFSValueRanking[][]).map(rValues => rValues.map(setValue));
-    }
-    return ((filter.values || []) as IFSValue[] | IFSValueRange[] | IFSValueRelativeDate[] || []).map(setValue);
-}

package/src/filters/adapters/flatUIToFD.ts

@@ -1,132 +0,0 @@
-import { adaptDateGroupingProperty } from "./adaptDateGroupingProperty";
-import { isEmpty } from "../../general/mix/isEmpty";
-import { adaptFilterValues } from "./adaptFilterValues";
-import { IFUFlattenedFilter } from "../interfaces/ui/IFUFlattenedFilter";
-import { IFSection } from "../interfaces/IFSection";
-import { FILTER_SECTION } from "../constants/common/FILTER_SECTION";
-import { FILTER_STRUCTURE_VERSION } from "../constants/common/FILTER_STRUCTURE_VERSION";
-import { IFSData } from "../interfaces/common/IFSData";
-import { IFSScope } from "../interfaces/common/IFSScope";
-import { IFSFilter } from "../interfaces/common/IFSFilter";
-import { IFSDataset } from "../interfaces/common/IFSDataset";
-import { cloneDeep } from "../../general/object/cloneDeep";
-
-/**
- * Generates a filter data structure from the flatttened UI filters.
- * @param uFilters Array of flattened filters from UI
- * @param version Tag for the version of the filter data structure
- * @returns a Filter Data.
- */
-export function flatUIToFD(uFilters: IFUFlattenedFilter[] = [], section: IFSection = FILTER_SECTION.ANYWHERE, enabled = true, version = FILTER_STRUCTURE_VERSION): IFSData {
-    return {
-        enabled,
-        section, 
-        version,
-        scopes: buildScopes(uFilters)
-    };
-}
-
-/**
- * Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
- * Also, adds and organizes filters by datasets
- * @param fbFilters Array of flat filters from UI
- * @returns an array of scopes structure.
- */
-function buildScopes(uFilters: IFUFlattenedFilter[]): IFSScope[] {
-    return uFilters.reduce((scopes: IFSScope[], uFilter: IFUFlattenedFilter) => {
-        const uiFilter: IFSFilter = buildFilter(uFilter);
-        const uiDataset: IFSDataset = buildDataset(uFilter);
-        const uiScope: IFSScope = buildScope(uFilter);
-
-        const scopeIndex = scopes.findIndex(sc => sc.scope === uFilter.extras.scope && sc.scopeid === uFilter.extras.scopeid);
-        const datasetIndex = scopeIndex > -1 ? scopes[scopeIndex].datasets.findIndex(dt => dt.qrveyid === uFilter.extras.dataset.qrveyid) : -1;
-
-        if (scopeIndex === -1) {
-            scopes.push({ ...uiScope, datasets: [{ ...uiDataset, filters: [uiFilter] }] });
-        } else if (datasetIndex === -1) {
-            scopes[scopeIndex].datasets.push({ ...uiDataset, filters: [uiFilter] });
-        } else {
-            scopes[scopeIndex].datasets[datasetIndex].filters.push(uiFilter);
-        }
-
-        return scopes;
-    }, [] as IFSScope[]);
-}
-
-/**
- * Gets an scope structure for the filter data
- * @param uFilter UI structure filter
- * @returns an scope structure
- */
-function buildScope(uFilter: IFUFlattenedFilter): IFSScope {
-    return {
-        collapsed: uFilter.extras.scopeInfo.collapsed,
-        enabled: uFilter.extras.scopeInfo.enabled,
-        datasets: undefined,
-        displayed: uFilter.extras.scopeInfo.displayed,
-        label: uFilter.extras.scopeInfo.label,
-        scope: uFilter.extras.scope,
-    };
-}
-
-/**
- * Gets an dataset structure for the filter data
- * @param uFilter a UI structure filter
- * @returns an dataset structure
- */
-function buildDataset(uFilter: IFUFlattenedFilter): IFSDataset {
-    return {
-        qrveyid: uFilter.extras.dataset.qrveyid,
-        collapsed: uFilter.extras.dataset.collapsed,
-        enabled: uFilter.extras.dataset.enabled,
-        displayed: uFilter.extras.dataset.displayed,
-        filters: undefined,
-        linkid: uFilter.extras.dataset.linkid,
-    };
-}
-
-/**
- * Gets an filter structure for the filter data
- * @param uFilter a UI structure filter
- * @returns an filter structure
- */
-function buildFilter(uFilter: IFUFlattenedFilter): IFSFilter {
-    uFilter = cloneDeep(uFilter);
-
-    const info = !isEmpty(uFilter.extras.info) ? { icon: uFilter.extras.info.icon, label: uFilter.extras.info.label } : undefined;
-    const property = adaptDateGroupingProperty(uFilter.property);
-
-    delete uFilter.extras.scopeInfo;
-    delete uFilter.extras.dataset;
-    return {
-        collapsed: uFilter.collapsed,
-        column: {
-            id: uFilter.column.id,
-            formulaType: uFilter.column.formulaType,
-            qrveyid: uFilter.column.qrveyid,
-            aggregate: uFilter.column.aggregate,
-            calculation: uFilter.column.calculation,
-            type: uFilter.column.type,
-        },
-        dateSection: uFilter.dateSection,
-        displayed: uFilter.displayed,
-        filterid: uFilter.filterid,
-        enabled: uFilter.enabled,
-        extras: {
-            ...uFilter.extras,
-            panelid: uFilter.extras.panelid,
-            filterLabel: uFilter.extras.filterLabel,
-            info,
-            scope: uFilter.extras.scope,
-            scopeid: uFilter.extras.scopeid,
-            section: uFilter.extras.section,
-        },
-        lookupDisplayIndex: uFilter.lookupDisplayIndex,
-        nullValues: uFilter.nullValues,
-        operator: uFilter.operator,
-        property,
-        selectAll: uFilter.selectAll,
-        validator: uFilter.validator,
-        values: adaptFilterValues(uFilter),
-    };
-}

package/src/filters/adapters/flatUIToLogic.ts

@@ -1,14 +0,0 @@
-import { flatUIToFD } from "./flatUIToFD";
-import { FDToLogic } from "./FDToLogic";
-import { IFUFlattenedFilter } from "../interfaces/ui/IFUFlattenedFilter";
-import { IFBLogic } from "../interfaces/backend/IFBLogic";
-
-/**
- * Generates a Logic structure from flattened UI filters
- * @param uFilter Array of flat filters from UI
- * @returns The logic structure
- */
-export function flatUIToLogic(uFilter: IFUFlattenedFilter[]): IFBLogic[] {
-    const uiFilters = flatUIToFD(uFilter);
-    return FDToLogic(uiFilters);
-}