@qrvey/utils 1.5.0-9 → 1.5.0

package/dist/filters/adapters/transformFilters.js

@@ -1,423 +0,0 @@
-import { isTokenLabel } from "../../tokens/isTokenLabel";
-import { FILTER_VALIDATOR } from "../constants/common/FILTER_VALIDATOR";
-import { FILTER_SCOPE } from "../constants/common/FILTER_SCOPE";
-import { FILTER_SECTION } from "../constants/common/FILTER_SECTION";
-import { FILTER_BACKEND_VALIDATOR } from "../constants/backend/FILTER_BACKEND_VALIDATOR";
-import { _get } from "../../general/object/get";
-import { capitalize } from "../../general/string/capitalize";
-/**
- * Transform the old filters structure into the new one
- *
- * @param {Object} oldFiltersObj an object with the old filters structure
- * @param {String} section could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE'
- *
- * @returns {Object} an object with the new filters structure
- *
- * @example
- *
- * const oldPreferenceFilters = {
- *   "WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
- *   "WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
- *   "WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
- *   "WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
- *   "WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
- *     "formulaId": null,
- *     "panelId": null,
- *     "values": [
- *       {
- *         "EQUALS": [
- *           {
- *             "id": "AK4M8UV2a0",
- *             "value": "A",
- *             "enabled": true,
- *             "imageUrl": null
- *           },
- *           {
- *             "id": "AK4M8UV2a1",
- *             "value": "B",
- *             "enabled": true,
- *             "imageUrl": null
- *           }
- *         ]
- *       }
- *     ],
- *     "bucketId": null,
- *     "text": "MC",
- *     "title": "MC",
- *     "type": "SINGLE_CHOICE",
- *     "qid": "AK4M8UV2",
- *     "dataset": {
- *       "sourceid": "xYOQAdpqT",
- *       "name": "Form All Questions",
- *       "qrveyid": "xYOQAdpqT",
- *       "text": "Form All Questions",
- *       "linkid": 0
- *     },
- *     "enabled": true,
- *     "linked": null
- *   }
- * };
- *
- * const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
- */
-export function transformFilters(oldFiltersObj = {}, section = FILTER_SECTION.ANYWHERE) {
-    const filterData = { enabled: true, logic: [], section };
-    const tempScopes = {};
-    Object.keys(oldFiltersObj).forEach((key) => {
-        if (key.endsWith("__ALL--ENABLED"))
-            filterData.enabled = oldFiltersObj[key];
-        if (!key.endsWith("ENABLED") &&
-            !key.endsWith("LABEL") &&
-            !key.endsWith("COLLAPSED")) {
-            const filterSeparator = "-_-";
-            const keyArray = key.split(filterSeparator);
-            const tempArray = [...keyArray];
-            tempArray.pop();
-            let enabledKey = "__ENABLED";
-            let collapsedKey = "__COLLAPSED";
-            let labelKey = "__LABEL";
-            if (keyArray.length === 5) {
-                tempArray.pop();
-                enabledKey = "__PANELS--ENABLED";
-                collapsedKey = "__PANELS--COLLAPSED";
-                labelKey = "__PANELS--LABEL";
-            }
-            const keyBase = tempArray.join(filterSeparator);
-            const scopeLabel = getScopeLabel(oldFiltersObj[keyBase + labelKey]);
-            const scopeId = tempArray[tempArray.length - 1] !== "VIEW"
-                ? tempArray[tempArray.length - 1]
-                : undefined;
-            const scopeKey = `${scopeLabel}|${scopeId}`;
-            if (!tempScopes[scopeKey]) {
-                tempScopes[scopeKey] = {
-                    enabled: oldFiltersObj[keyBase + enabledKey],
-                    scope: scopeLabel,
-                    filters: [],
-                    uiExtras: {
-                        scopeid: scopeId,
-                        collapsed: oldFiltersObj[keyBase + collapsedKey],
-                        section,
-                    },
-                };
-            }
-            const filtersObj = validateComplexTypes(oldFiltersObj[key], Object.keys(oldFiltersObj[key].values[0]));
-            const validations = Object.keys(filtersObj.values[0]);
-            tempScopes[scopeKey].filters.push({
-                operator: "AND",
-                expressions: [
-                    {
-                        operator: "OR",
-                        uiExtras: {
-                            expressionid: `${filtersObj.qid}|${scopeId}|${filtersObj.panelid || ""}`,
-                        },
-                        expressions: getExpressions(filtersObj, validations, scopeLabel, scopeId, section),
-                    },
-                ],
-            });
-        }
-    });
-    filterData.logic = Object.values(tempScopes);
-    return filterData;
-}
-function validateComplexTypes(oldFiltersItem, validations) {
-    if (![
-        "IMAGEUPLOAD",
-        "TEXTFIELD",
-        "LONGTEXT",
-        "NAME",
-        "ADDRESS",
-        "USADDRESS",
-    ].includes(oldFiltersItem.type))
-        return oldFiltersItem;
-    const complexFiltersItem = Object.assign(Object.assign({}, oldFiltersItem), { values: [{}] });
-    validations.forEach((valKey) => {
-        oldFiltersItem.values[0][valKey].forEach((value) => {
-            const newKey = `${valKey}|${(value.targetFilter || value.property || "")
-                .toLowerCase()
-                .replace("_text", "")
-                .replace("_type", "type")}`;
-            if (!complexFiltersItem.values[0][newKey]) {
-                complexFiltersItem.values[0][newKey] = [value];
-            }
-            else {
-                complexFiltersItem.values[0][newKey].push(value);
-            }
-        });
-    });
-    return complexFiltersItem;
-}
-function getScopeLabel(oldScopeLabel) {
-    switch (oldScopeLabel) {
-        case "GLOBAL":
-            return FILTER_SCOPE.GLOBAL;
-        case "PAGE":
-            return FILTER_SCOPE.PAGE;
-        case "TAB":
-            return FILTER_SCOPE.TAB;
-        case "PANEL":
-            return FILTER_SCOPE.CHART;
-        default:
-            return oldScopeLabel;
-    }
-}
-function getValidationType(oldValidation, columnType, formulaType) {
-    switch (oldValidation) {
-        case "EQUALS":
-        case "EQUAL":
-            return FILTER_VALIDATOR.EQUALS;
-        case "NOT_EQUALS":
-        case "NOT_EQUAL":
-            return FILTER_VALIDATOR.NOT_EQUAL;
-        case "CONTAINS":
-        case "CONTAIN":
-            return FILTER_VALIDATOR.CONTAINS;
-        case "NOT_CONTAINS":
-        case "NOT_CONTAIN":
-            return FILTER_VALIDATOR.NOT_CONTAIN;
-        case "LESS_THAN":
-        case "LESS_THAN_OR_EQUAL":
-            return FILTER_VALIDATOR.LESS_THAN_EQUAL;
-        case "GREATER_THAN":
-        case "GREATER_THAN_OR_EQUAL":
-            return FILTER_VALIDATOR.GREATER_THAN_EQUAL;
-        case "BETWEEN":
-        case "YEAR":
-        case "MONTH_YEAR":
-        case "QUARTER":
-        case "WEEK":
-        case "SECOND":
-        case "MINUTE":
-        case "HOUR":
-        case "DAY":
-            return ![columnType, formulaType].includes("DATE")
-                ? FILTER_VALIDATOR.BETWEEN_INCLUSIVE
-                : FILTER_BACKEND_VALIDATOR.RANGE;
-        default:
-            return oldValidation;
-    }
-}
-function getValidator(oldValidation) {
-    switch (oldValidation) {
-        case "EQUALS":
-        case "EQUAL":
-        case "YEAR":
-        case "MONTH_YEAR":
-        case "QUARTER":
-        case "WEEK":
-        case "SECOND":
-        case "MINUTE":
-        case "HOUR":
-        case "DAY":
-            return FILTER_VALIDATOR.EQUALS;
-        case "NOT_EQUALS":
-        case "NOT_EQUAL":
-            return FILTER_VALIDATOR.NOT_EQUAL;
-        case "CONTAINS":
-        case "CONTAIN":
-            return FILTER_VALIDATOR.CONTAINS;
-        case "NOT_CONTAINS":
-        case "NOT_CONTAIN":
-            return FILTER_VALIDATOR.NOT_CONTAIN;
-        case "BETWEEN":
-            return FILTER_VALIDATOR.BETWEEN_INCLUSIVE;
-        case "LESS_THAN":
-        case "LESS_THAN_OR_EQUAL":
-            return FILTER_VALIDATOR.LESS_THAN_EQUAL;
-        case "GREATER_THAN":
-        case "GREATER_THAN_OR_EQUAL":
-            return FILTER_VALIDATOR.GREATER_THAN_EQUAL;
-        case "IS_EMPTY":
-            return FILTER_VALIDATOR.IS_NULL;
-        case "IS_NOT_EMPTY":
-            return FILTER_VALIDATOR.IS_NOT_NULL;
-        default:
-            return oldValidation;
-    }
-}
-function getProperty(filterObjItem, validationKey) {
-    if (filterObjItem.type === "IMAGE")
-        return "answer_id";
-    const value = _get(filterObjItem, `values[0]['${validationKey}'][0]`, {});
-    const property = filterObjItem.property || value.property || value.targetFilter;
-    return property && property.toUpperCase();
-}
-function getDateProperty(validationKey, columnType, formulaType) {
-    if (![columnType, formulaType].includes("DATE"))
-        return;
-    return [
-        "MONTH_YEAR",
-        "YEAR",
-        "QUARTER",
-        "WEEK",
-        "HOUR",
-        "MINUTE",
-        "SECOND",
-    ].includes(validationKey)
-        ? validationKey.split("_")[0].toLowerCase()
-        : "day";
-}
-function getFilterRangeValue(range, minProp = "min", maxProp = "max", extras = {}) {
-    return Object.assign({ [minProp]: range.from || range.gte, [maxProp]: range.to || range.lte }, extras);
-}
-function getUiRangeValue(oldValue) {
-    if (oldValue.label)
-        return (oldValue.label + "").replace("-", " ");
-    const range = oldValue.range || oldValue;
-    return `${range.from || range.gte} - ${range.to || range.lte}`;
-}
-function getRankingFBvalues(values) {
-    const returnValues = [];
-    values
-        .map((vItem) => (Object.assign(Object.assign({}, vItem), { position: +vItem.position + 1 })))
-        .forEach((vItem) => {
-        const groupIndex = returnValues.findIndex((group) => group.every((groupItem) => groupItem.value.value !== vItem.value) &&
-            group.every((groupItem) => groupItem.position !== vItem.position));
-        const returnItem = {
-            position: vItem.position,
-            value: { enabled: vItem.enabled, value: vItem.value },
-        };
-        if (groupIndex === -1)
-            returnValues.push([returnItem]);
-        else
-            returnValues[groupIndex].push(returnItem);
-    });
-    return returnValues;
-}
-function getValues(values, columnType, oldValidation = "EQUAL", destination = "value", formulaType) {
-    switch (oldValidation) {
-        case "BETWEEN":
-        case "YEAR":
-        case "MONTH_YEAR":
-            return destination === "value"
-                ? values.map((val) => getFilterRangeValue(val.value.range || val.value, "gte", "lte"))
-                : destination === "uiValue"
-                    ? values.map((val) => getFilterRangeValue(val.value.range || val.value, "min", "max", {
-                        enabled: val.enabled,
-                        value: getUiRangeValue(val.value),
-                        validationLabel: oldValidation,
-                    }))
-                    : ["YEAR", "MONTH_YEAR", "QUARTER"].includes(oldValidation)
-                        ? values.map((item) => ({ value: getUiRangeValue(item.value) }))
-                        : values.map((val) => getFilterRangeValue(val.value.range || val.value));
-        case "LESS_THAN":
-        case "GREATER_THAN": {
-            const prop = oldValidation === "LESS_THAN" ? "lte" : "gte";
-            return destination === "value"
-                ? values.map((val) => getFilterRangeValue({ [prop]: val.value }, "gte", "lte"))
-                : destination === "uiValue"
-                    ? values.map((val) => getFilterRangeValue({ [prop]: val.value }, "min", "max", {
-                        enabled: val.enabled,
-                        value: val.value,
-                    }))
-                    : values.map((val) => getFilterRangeValue({ [prop]: val.value }));
-        }
-        case "IS_EMPTY":
-        case "IS_NOT_EMPTY": {
-            const valueClean = getValidator(oldValidation)
-                .toLowerCase()
-                .split("_")
-                .map((v) => capitalize(v))
-                .join(" ");
-            return destination === "value"
-                ? [valueClean]
-                : destination === "uiValue"
-                    ? values.map((val) => ({ value: valueClean, enabled: val.enabled }))
-                    : [];
-        }
-        default:
-            return getFilterEqualValues(values, columnType, destination, formulaType);
-    }
-}
-function getFilterEqualValues(values, columnType, destination = "value", formulaType) {
-    if (columnType === "RANKING") {
-        return destination === "value"
-            ? values.map((item) => ({ position: +item.position, value: item.value }))
-            : destination === "uiValue"
-                ? values.map((item) => ({
-                    value: getUiRangeValue({ from: item.value, to: +item.position + 1 }),
-                    enabled: true,
-                }))
-                : getRankingFBvalues(values);
-    }
-    return destination === "value"
-        ? values.map((item) => {
-            let value = item.value;
-            if ([columnType, formulaType].includes("DATE") &&
-                !isTokenLabel(value)) {
-                value = getFilterRangeValue(item.value.range || item.value, "gte", "lte");
-            }
-            else if (columnType === "YES_NO") {
-                value = item.value.toLowerCase();
-            }
-            else if (columnType === "IMAGE") {
-                value = item.id || item.answerid || item.answer_id;
-            }
-            else {
-                value = String(item.value);
-            }
-            return value;
-        })
-        : values.map((item) => ({
-            value: columnType === "YES_NO"
-                ? item.value.toLowerCase()
-                : [columnType, formulaType].includes("DATE")
-                    ? item.value.label || item.value
-                    : String(item.value),
-            valueid: columnType === "EXPRESSION" ? undefined : item.id || item.answerid,
-            enabled: item.enabled || true,
-        }));
-}
-function getFormulaType(oldFiltersItem) {
-    if (oldFiltersItem.formulaType)
-        return oldFiltersItem.formulaType;
-    if (oldFiltersItem.formulaId)
-        return oldFiltersItem.type === "NUMERIC"
-            ? "number"
-            : oldFiltersItem.type === "DATE"
-                ? "date"
-                : "string";
-}
-function getExpressions(oldFiltersItem, validations, scopeLabel, scopeid, section) {
-    const expressions = [];
-    validations.forEach((valKey) => {
-        const valKeyArray = valKey.split("|");
-        const validationKey = valKeyArray[0];
-        const property = valKeyArray[1] || getProperty(oldFiltersItem, validationKey);
-        const formulaType = getFormulaType(oldFiltersItem);
-        const questionType = formulaType ? "FORMULA" : oldFiltersItem.type;
-        const expressionItem = {
-            enabled: oldFiltersItem.enabled,
-            property: property,
-            qrveyid: oldFiltersItem.dataset.qrveyid,
-            questionid: oldFiltersItem.qid,
-            formulaType: formulaType,
-            questionType: questionType,
-            type: questionType,
-            validationType: getValidationType(validationKey, questionType, formulaType && formulaType.toUpperCase()),
-            uiExtras: {
-                column: {
-                    dataset: {
-                        qrveyid: oldFiltersItem.dataset.qrveyid,
-                        name: oldFiltersItem.dataset.name,
-                    },
-                    formulaType: formulaType,
-                    id: oldFiltersItem.qid,
-                    qrveyid: oldFiltersItem.dataset.qrveyid,
-                    text: oldFiltersItem.text,
-                    type: questionType,
-                },
-                operator: "AND",
-                property: getDateProperty(validationKey, questionType, formulaType && formulaType.toUpperCase()) || property,
-                validator: getValidator(validationKey),
-                panelid: oldFiltersItem.panelId,
-                panelName: oldFiltersItem.panelId ? oldFiltersItem.title : undefined,
-                uiHidden: false,
-                scope: scopeLabel,
-                scopeid,
-                section,
-            },
-        };
-        expressions.push(Object.assign(Object.assign({}, expressionItem), { value: getValues(oldFiltersItem.values[0][valKey], questionType, validationKey, "value", formulaType && formulaType.toUpperCase()), uiExtras: Object.assign(Object.assign({}, expressionItem.uiExtras), { values: getValues(oldFiltersItem.values[0][valKey], questionType, validationKey, "values", formulaType && formulaType.toUpperCase()), uiValue: getValues(oldFiltersItem.values[0][valKey], questionType, validationKey, "uiValue", formulaType && formulaType.toUpperCase()) }) }));
-    });
-    return expressions;
-}