@lightdash/common 0.2104.7 → 0.2104.8

package/dist/types/types/filter.js

@@ -0,0 +1,287 @@
+export var FilterType;
+(function (FilterType) {
+    FilterType["STRING"] = "string";
+    FilterType["NUMBER"] = "number";
+    FilterType["DATE"] = "date";
+    FilterType["BOOLEAN"] = "boolean";
+})(FilterType || (FilterType = {}));
+export var FilterOperator;
+(function (FilterOperator) {
+    FilterOperator["NULL"] = "isNull";
+    FilterOperator["NOT_NULL"] = "notNull";
+    FilterOperator["EQUALS"] = "equals";
+    FilterOperator["NOT_EQUALS"] = "notEquals";
+    FilterOperator["STARTS_WITH"] = "startsWith";
+    FilterOperator["ENDS_WITH"] = "endsWith";
+    FilterOperator["INCLUDE"] = "include";
+    FilterOperator["NOT_INCLUDE"] = "doesNotInclude";
+    FilterOperator["LESS_THAN"] = "lessThan";
+    FilterOperator["LESS_THAN_OR_EQUAL"] = "lessThanOrEqual";
+    FilterOperator["GREATER_THAN"] = "greaterThan";
+    FilterOperator["GREATER_THAN_OR_EQUAL"] = "greaterThanOrEqual";
+    FilterOperator["IN_THE_PAST"] = "inThePast";
+    FilterOperator["NOT_IN_THE_PAST"] = "notInThePast";
+    FilterOperator["IN_THE_NEXT"] = "inTheNext";
+    FilterOperator["IN_THE_CURRENT"] = "inTheCurrent";
+    FilterOperator["NOT_IN_THE_CURRENT"] = "notInTheCurrent";
+    FilterOperator["IN_BETWEEN"] = "inBetween";
+    FilterOperator["NOT_IN_BETWEEN"] = "notInBetween";
+})(FilterOperator || (FilterOperator = {}));
+export var UnitOfTime;
+(function (UnitOfTime) {
+    UnitOfTime["milliseconds"] = "milliseconds";
+    UnitOfTime["seconds"] = "seconds";
+    UnitOfTime["minutes"] = "minutes";
+    UnitOfTime["hours"] = "hours";
+    UnitOfTime["days"] = "days";
+    UnitOfTime["weeks"] = "weeks";
+    UnitOfTime["months"] = "months";
+    UnitOfTime["quarters"] = "quarters";
+    UnitOfTime["years"] = "years";
+})(UnitOfTime || (UnitOfTime = {}));
+export const unitOfTimeFormat = {
+    milliseconds: 'YYYY-MM-DD HH:mm:ss',
+    seconds: 'YYYY-MM-DD HH:mm:ss',
+    minutes: 'YYYY-MM-DD HH:mm',
+    hours: 'YYYY-MM-DD HH',
+    days: 'YYYY-MM-DD',
+    weeks: 'YYYY-MM-DD',
+    months: 'YYYY-MM',
+    quarters: 'YYYY-MM',
+    years: 'YYYY',
+};
+export const getUnitsOfTimeGreaterOrEqual = (unit) => {
+    const unitsInOrder = [
+        UnitOfTime.milliseconds,
+        UnitOfTime.seconds,
+        UnitOfTime.minutes,
+        UnitOfTime.hours,
+        UnitOfTime.days,
+        UnitOfTime.weeks,
+        UnitOfTime.months,
+        UnitOfTime.quarters,
+        UnitOfTime.years,
+    ];
+    const index = unitsInOrder.indexOf(unit);
+    if (index === -1) {
+        // return the original array if the unit is not found
+        return unitsInOrder;
+    }
+    return unitsInOrder.slice(index);
+};
+export const isJoinModelRequiredFilter = (filter) => 'tableName' in filter.target;
+export const isDashboardFieldTarget = (target) => target !== null &&
+    typeof target === 'object' &&
+    'fieldId' in target &&
+    'tableName' in target;
+export const isDateFilterRule = (filter) => 'unitOfTime' in (filter.settings || {});
+/* Utils */
+export const isOrFilterGroup = (value) => 'or' in value;
+export const isAndFilterGroup = (value) => 'and' in value;
+export const isFilterGroup = (value) => isOrFilterGroup(value) || isAndFilterGroup(value);
+export const isFilterRule = (value) => 'id' in value && 'target' in value && 'operator' in value;
+export const isFilterTarget = (value) => !!value && typeof value === 'object' && 'fieldId' in value;
+export const isMetricFilterTarget = (value) => !!value && typeof value === 'object' && 'fieldRef' in value;
+export const flattenFilterGroup = (filterGroup) => {
+    // Explicitly checking for undefined filter groups (and || or), saved filter group somehow was undefined when saving
+    const groupItems = isAndFilterGroup(filterGroup)
+        ? filterGroup.and
+        : filterGroup.or;
+    return (groupItems || []).flatMap((item) => {
+        if (isFilterGroup(item)) {
+            return flattenFilterGroup(item);
+        }
+        return [item];
+    });
+};
+export const getFilterRules = (filters) => {
+    const rules = [];
+    if (filters.dimensions) {
+        rules.push(...flattenFilterGroup(filters.dimensions));
+    }
+    if (filters.metrics) {
+        rules.push(...flattenFilterGroup(filters.metrics));
+    }
+    if (filters.tableCalculations) {
+        rules.push(...flattenFilterGroup(filters.tableCalculations));
+    }
+    return rules;
+};
+export const updateFieldIdInFilterGroupItem = (filterGroupItem, previousName, newName) => {
+    if (isFilterGroup(filterGroupItem)) {
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
+        updateFieldIdInFilters(filterGroupItem, previousName, newName);
+    }
+    else if (filterGroupItem.target.fieldId === previousName) {
+        // eslint-disable-next-line no-param-reassign
+        filterGroupItem.target.fieldId = newName;
+    }
+};
+export const updateFieldIdInFilters = (filterGroup, previousName, newName) => {
+    if (filterGroup) {
+        if (isOrFilterGroup(filterGroup)) {
+            filterGroup.or.forEach((item) => updateFieldIdInFilterGroupItem(item, previousName, newName));
+        }
+        else if (isAndFilterGroup(filterGroup)) {
+            filterGroup.and.forEach((item) => updateFieldIdInFilterGroupItem(item, previousName, newName));
+        }
+    }
+};
+export const removeFieldFromFilterGroup = (filterGroup, fieldId) => {
+    if (!filterGroup) {
+        return undefined;
+    }
+    const removeFiltersGroupItems = (items) => items.reduce((acc, item) => {
+        if (isFilterGroup(item)) {
+            const updatedGroup = removeFieldFromFilterGroup(item, fieldId); // remove field from filter groups recursively
+            if (updatedGroup) {
+                acc.push(updatedGroup);
+            }
+        }
+        else if (item.target.fieldId !== fieldId) {
+            // keep filter rule if fieldId does not match
+            acc.push(item);
+        }
+        return acc;
+    }, []);
+    if (isOrFilterGroup(filterGroup)) {
+        const updatedItems = removeFiltersGroupItems(filterGroup.or);
+        if (updatedItems.length === 0) {
+            return undefined;
+        }
+        return {
+            ...filterGroup,
+            or: updatedItems,
+        };
+    }
+    const updatedItems = removeFiltersGroupItems(filterGroup.and);
+    if (updatedItems.length === 0) {
+        return undefined;
+    }
+    return {
+        ...filterGroup,
+        and: updatedItems,
+    };
+};
+export const applyDimensionOverrides = (dashboardFilters, overrides) => {
+    const overrideArray = overrides instanceof Array ? overrides : overrides.dimensions;
+    // Apply overrides to existing dashboard dimensions
+    const overriddenDimensions = dashboardFilters.dimensions.map((dimension) => {
+        const override = overrideArray.find((overrideDimension) => overrideDimension.id === dimension.id);
+        if (override) {
+            return {
+                ...override,
+                tileTargets: dimension.tileTargets,
+            };
+        }
+        return dimension;
+    });
+    // Add scheduler filters that don't exist in dashboard saved filters
+    const existingIds = new Set(dashboardFilters.dimensions.map((d) => d.id));
+    const newDimensions = overrideArray.filter((schedulerFilter) => !existingIds.has(schedulerFilter.id));
+    overriddenDimensions.push(...newDimensions);
+    return overriddenDimensions;
+};
+export const isDashboardFilterRule = (value) => isFilterRule(value) && 'tableName' in value.target;
+export var FilterGroupOperator;
+(function (FilterGroupOperator) {
+    FilterGroupOperator["and"] = "and";
+    FilterGroupOperator["or"] = "or";
+})(FilterGroupOperator || (FilterGroupOperator = {}));
+export const convertDashboardFiltersToFilters = (dashboardFilters) => {
+    const { dimensions, metrics, tableCalculations } = dashboardFilters;
+    const filters = {};
+    if (dimensions.length > 0) {
+        filters.dimensions = {
+            id: 'dashboard_dimension_filters',
+            and: dimensions.map((dimension) => dimension),
+        };
+    }
+    if (metrics.length > 0) {
+        filters.metrics = {
+            id: 'dashboard_dimension_metrics',
+            and: metrics.map((metric) => metric),
+        };
+    }
+    if (tableCalculations.length > 0) {
+        filters.tableCalculations = {
+            id: 'dashboard_tablecalculation_filters',
+            and: tableCalculations.map((tableCalculation) => tableCalculation),
+        };
+    }
+    return filters;
+};
+const isDashboardTileTargetFilterOverride = (filter) => typeof filter === 'object' || typeof filter === 'boolean';
+export const convertDashboardFiltersParamToDashboardFilters = (dashboardFilters) => Object.entries(dashboardFilters).reduce((result, [key, value]) => ({
+    ...result,
+    [key]: value.map((f) => ({
+        ...f,
+        ...(f.tileTargets && {
+            tileTargets: f.tileTargets.reduce((tileTargetsResult, tileTarget) => {
+                const targetName = Object.keys(tileTarget)[0];
+                const targetValue = Object.values(tileTarget)[0];
+                if (isDashboardTileTargetFilterOverride(tileTarget)) {
+                    return {
+                        ...tileTargetsResult,
+                        ...{ [targetName]: targetValue },
+                    };
+                }
+                return tileTargetsResult;
+            }, {}),
+        }),
+    })),
+}), { dimensions: [], metrics: [], tableCalculations: [] });
+export const compressDashboardFiltersToParam = (dashboardFilters) => Object.entries(dashboardFilters).reduce((result, [key, value]) => ({
+    ...result,
+    [key]: value.map((f) => ({
+        ...f,
+        ...(f.tileTargets && {
+            tileTargets: Object.entries(f.tileTargets).reduce((tileTargetsResult, [tileTargetKey, tileTargetValue]) => {
+                // If the filter is not disabled for this tile
+                // AND the table and field match, we omit it.
+                // The filter will be automatically applied there
+                if (tileTargetValue !== false &&
+                    isDashboardFieldTarget(tileTargetValue) &&
+                    tileTargetValue.fieldId === f.target.fieldId &&
+                    tileTargetValue.tableName === f.target.tableName) {
+                    return tileTargetsResult;
+                }
+                return [
+                    ...tileTargetsResult,
+                    {
+                        [tileTargetKey]: tileTargetValue,
+                    },
+                ];
+            }, []),
+        }),
+    })),
+}), { dimensions: [], metrics: [], tableCalculations: [] });
+export const isFilterRuleDefinedForFieldId = (filterGroup, fieldId, isInterval = false) => {
+    // Check if the filter group is an 'and' or 'or' group
+    const filterGroupItems = isAndFilterGroup(filterGroup)
+        ? filterGroup.and
+        : filterGroup.or;
+    // If the item is a filter rule, check if its id matches the provided filter rule id
+    const isMatchingFieldId = (item) => {
+        if (!isFilterGroup(item)) {
+            // If the item is not a filter group, check if it matches the fieldId
+            return isInterval
+                ? item.target.fieldId.startsWith(fieldId)
+                : item.target.fieldId === fieldId;
+        }
+        return false;
+    };
+    const isFilterRulePresent = (item) => {
+        if (isMatchingFieldId(item)) {
+            return true;
+        }
+        if (isFilterGroup(item)) {
+            // If the item is a filter group, recursively check its items
+            return isFilterRuleDefinedForFieldId(item, fieldId, isInterval);
+        }
+        return false;
+    };
+    // If the filter rule was not found in the filter group, return false
+    return filterGroupItems.some(isFilterRulePresent);
+};
+//# sourceMappingURL=filter.js.map

package/dist/types/types/filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../../src/types/filter.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,2BAAa,CAAA;IACb,iCAAmB,CAAA;AACvB,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAED,MAAM,CAAN,IAAY,cAoBX;AApBD,WAAY,cAAc;IACtB,iCAAe,CAAA;IACf,sCAAoB,CAAA;IACpB,mCAAiB,CAAA;IACjB,0CAAwB,CAAA;IACxB,4CAA0B,CAAA;IAC1B,wCAAsB,CAAA;IACtB,qCAAmB,CAAA;IACnB,gDAA8B,CAAA;IAC9B,wCAAsB,CAAA;IACtB,wDAAsC,CAAA;IACtC,8CAA4B,CAAA;IAC5B,8DAA4C,CAAA;IAC5C,2CAAyB,CAAA;IACzB,kDAAgC,CAAA;IAChC,2CAAyB,CAAA;IACzB,iDAA+B,CAAA;IAC/B,wDAAsC,CAAA;IACtC,0CAAwB,CAAA;IACxB,iDAA+B,CAAA;AACnC,CAAC,EApBW,cAAc,KAAd,cAAc,QAoBzB;AAQD,MAAM,CAAN,IAAY,UAUX;AAVD,WAAY,UAAU;IAClB,2CAA6B,CAAA;IAC7B,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,6BAAe,CAAA;IACf,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,6BAAe,CAAA;AACnB,CAAC,EAVW,UAAU,KAAV,UAAU,QAUrB;AAED,MAAM,CAAC,MAAM,gBAAgB,GAA+B;IACxD,YAAY,EAAE,qBAAqB;IACnC,OAAO,EAAE,qBAAqB;IAC9B,OAAO,EAAE,kBAAkB;IAC3B,KAAK,EAAE,eAAe;IACtB,IAAI,EAAE,YAAY;IAClB,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,SAAS;IACjB,QAAQ,EAAE,SAAS;IACnB,KAAK,EAAE,MAAM;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CACxC,IAAgB,EACJ,EAAE;IACd,MAAM,YAAY,GAAiB;QAC/B,UAAU,CAAC,YAAY;QACvB,UAAU,CAAC,OAAO;QAClB,UAAU,CAAC,OAAO;QAClB,UAAU,CAAC,KAAK;QAChB,UAAU,CAAC,IAAI;QACf,UAAU,CAAC,KAAK;QAChB,UAAU,CAAC,MAAM;QACjB,UAAU,CAAC,QAAQ;QACnB,UAAU,CAAC,KAAK;KACnB,CAAC;IACF,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QACf,qDAAqD;QACrD,OAAO,YAAY,CAAC;IACxB,CAAC;IACD,OAAO,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC,CAAC;AAkCF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACrC,MAA+B,EACM,EAAE,CAAC,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC;AASzE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAClC,MAAe,EACe,EAAE,CAChC,MAAM,KAAK,IAAI;IACf,OAAO,MAAM,KAAK,QAAQ;IAC1B,SAAS,IAAI,MAAM;IACnB,WAAW,IAAI,MAAM,CAAC;AAsC1B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC5B,MAA2E,EACnD,EAAE,CAAC,YAAY,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC;AAyCvE,WAAW;AAEX,MAAM,CAAC,MAAM,eAAe,GAAG,CAC3B,KAAsB,EACA,EAAE,CAAC,IAAI,IAAI,KAAK,CAAC;AAE3C,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC5B,KAAsB,EACC,EAAE,CAAC,KAAK,IAAI,KAAK,CAAC;AAE7C,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAsB,EAAwB,EAAE,CAC1E,eAAe,CAAC,KAAK,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAEtD,MAAM,CAAC,MAAM,YAAY,GAAG,CACxB,KAAuC,EACpB,EAAE,CACrB,IAAI,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,CAAC;AAE9D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAc,EAAwB,EAAE,CACnE,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,SAAS,IAAI,KAAK,CAAC;AAE/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAChC,KAAc,EACe,EAAE,CAC/B,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,IAAI,KAAK,CAAC;AAEhE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,WAAwB,EAAgB,EAAE;IACzE,oHAAoH;IACpH,MAAM,UAAU,GAAkC,gBAAgB,CAC9D,WAAW,CACd;QACG,CAAC,CAAC,WAAW,CAAC,GAAG;QACjB,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;IAErB,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACvC,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAgB,EAAE;IAC7D,MAAM,KAAK,GAAiB,EAAE,CAAC;IAE/B,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC1C,eAAgC,EAChC,YAAoB,EACpB,OAAe,EACX,EAAE;IACN,IAAI,aAAa,CAAC,eAAe,CAAC,EAAE,CAAC;QACjC,mEAAmE;QACnE,sBAAsB,CAAC,eAAe,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;SAAM,IAAI,eAAe,CAAC,MAAM,CAAC,OAAO,KAAK,YAAY,EAAE,CAAC;QACzD,6CAA6C;QAC7C,eAAe,CAAC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;IAC7C,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAClC,WAAoC,EACpC,YAAoB,EACpB,OAAe,EACX,EAAE;IACN,IAAI,WAAW,EAAE,CAAC;QACd,IAAI,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,WAAW,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC5B,8BAA8B,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAC9D,CAAC;QACN,CAAC;aAAM,IAAI,gBAAgB,CAAC,WAAW,CAAC,EAAE,CAAC;YACvC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7B,8BAA8B,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAC9D,CAAC;QACN,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACtC,WAAoC,EACpC,OAAe,EACQ,EAAE;IACzB,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,uBAAuB,GAAG,CAC5B,KAAwB,EACP,EAAE,CACnB,KAAK,CAAC,MAAM,CAAoB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QAC1C,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,MAAM,YAAY,GAAG,0BAA0B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,8CAA8C;YAC9G,IAAI,YAAY,EAAE,CAAC;gBACf,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACzC,6CAA6C;YAC7C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QACD,OAAO,GAAG,CAAC;IACf,CAAC,EAAE,EAAE,CAAC,CAAC;IAEX,IAAI,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,MAAM,YAAY,GAAG,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC7D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO;YACH,GAAG,WAAW;YACd,EAAE,EAAE,YAAY;SACnB,CAAC;IACN,CAAC;IACD,MAAM,YAAY,GAAG,uBAAuB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,OAAO;QACH,GAAG,WAAW;QACd,GAAG,EAAE,YAAY;KACpB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACnC,gBAAkC,EAClC,SAAmD,EACrD,EAAE;IACA,MAAM,aAAa,GACf,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC;IAElE,mDAAmD;IACnD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,GAAG,CACxD,CAAC,SAAS,EAAE,EAAE;QACV,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAC/B,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAC/D,CAAC;QACF,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO;gBACH,GAAG,QAAQ;gBACX,WAAW,EAAE,SAAS,CAAC,WAAW;aACrC,CAAC;QACN,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC,CACJ,CAAC;IAEF,oEAAoE;IACpE,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1E,MAAM,aAAa,GAAG,aAAa,CAAC,MAAM,CACtC,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAC5D,CAAC;IACF,oBAAoB,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;IAE5C,OAAO,oBAAoB,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACjC,KAAqB,EACO,EAAE,CAC9B,YAAY,CAAC,KAAK,CAAC,IAAI,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC;AAEvD,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,kCAAW,CAAA;IACX,gCAAS,CAAA;AACb,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AAED,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC5C,gBAAkC,EAC3B,EAAE;IACT,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,gBAAgB,CAAC;IACpE,MAAM,OAAO,GAAY,EAAE,CAAC;IAC5B,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,UAAU,GAAG;YACjB,EAAE,EAAE,6BAA6B;YACjC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC;SAChD,CAAC;IACN,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,OAAO,GAAG;YACd,EAAE,EAAE,6BAA6B;YACjC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC;SACvC,CAAC;IACN,CAAC;IACD,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAO,CAAC,iBAAiB,GAAG;YACxB,EAAE,EAAE,oCAAoC;YACxC,GAAG,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC;SACrE,CAAC;IACN,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,mCAAmC,GAAG,CACxC,MAAoD,EACP,EAAE,CAC/C,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,SAAS,CAAC;AAE9D,MAAM,CAAC,MAAM,8CAA8C,GAAG,CAC1D,gBAAiD,EACjC,EAAE,CAClB,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,MAAM,CACnC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IACvB,GAAG,MAAM;IACT,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrB,GAAG,CAAC;QACJ,GAAG,CAAC,CAAC,CAAC,WAAW,IAAI;YACjB,WAAW,EAAE,CAAC,CAAC,WAAW,CAAC,MAAM,CAE/B,CAAC,iBAAiB,EAAE,UAAU,EAAE,EAAE;gBAChC,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjD,IAAI,mCAAmC,CAAC,UAAU,CAAC,EAAE,CAAC;oBAClD,OAAO;wBACH,GAAG,iBAAiB;wBACpB,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE;qBACnC,CAAC;gBACN,CAAC;gBACD,OAAO,iBAAiB,CAAC;YAC7B,CAAC,EAAE,EAAE,CAAC;SACT,CAAC;KACL,CAAC,CAAC;CACN,CAAC,EACF,EAAE,UAAU,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,CACzD,CAAC;AAEN,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAC3C,gBAAkC,EACH,EAAE,CACjC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,MAAM,CACnC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IACvB,GAAG,MAAM;IACT,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrB,GAAG,CAAC;QACJ,GAAG,CAAC,CAAC,CAAC,WAAW,IAAI;YACjB,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,CAC7C,CACI,iBAEE,EACF,CAAC,aAAa,EAAE,eAAe,CAAC,EAClC,EAAE;gBACA,8CAA8C;gBAC9C,6CAA6C;gBAC7C,iDAAiD;gBACjD,IACI,eAAe,KAAK,KAAK;oBACzB,sBAAsB,CAAC,eAAe,CAAC;oBACvC,eAAe,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO;oBAC5C,eAAe,CAAC,SAAS,KAAK,CAAC,CAAC,MAAM,CAAC,SAAS,EAClD,CAAC;oBACC,OAAO,iBAAiB,CAAC;gBAC7B,CAAC;gBAED,OAAO;oBACH,GAAG,iBAAiB;oBACpB;wBACI,CAAC,aAAa,CAAC,EAAE,eAAe;qBACnC;iBACJ,CAAC;YACN,CAAC,EACD,EAAE,CACL;SACJ,CAAC;KACL,CAAC,CAAC;CACN,CAAC,EACF,EAAE,UAAU,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,CACzD,CAAC;AAEN,MAAM,CAAC,MAAM,6BAA6B,GAAG,CACzC,WAAwB,EACxB,OAAe,EACf,aAAsB,KAAK,EACpB,EAAE;IACT,sDAAsD;IACtD,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,WAAW,CAAC;QAClD,CAAC,CAAC,WAAW,CAAC,GAAG;QACjB,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;IAErB,oFAAoF;IACpF,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAE,EAAE;QAChD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,qEAAqE;YACrE,OAAO,UAAU;gBACb,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;gBACzC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,OAAO,CAAC;QAC1C,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IACF,MAAM,mBAAmB,GAAG,CACxB,IAAiD,EAC1C,EAAE;QACT,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,6DAA6D;YAC7D,OAAO,6BAA6B,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IACF,qEAAqE;IACrE,OAAO,gBAAgB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;AACtD,CAAC,CAAC"}

package/dist/types/types/filter.test.js

@@ -0,0 +1,372 @@
+import cloneDeep from 'lodash/cloneDeep';
+import { compressDashboardFiltersToParam, convertDashboardFiltersParamToDashboardFilters, FilterOperator, isFilterRuleDefinedForFieldId, removeFieldFromFilterGroup, } from './filter';
+describe('compress and uncompress dashboard filters', () => {
+    describe('compressDashboardFiltersToParam', () => {
+        const DUMMY_DIMENSION = {
+            id: 'filter-id',
+            label: 'A label',
+            operator: FilterOperator.EQUALS,
+            target: {
+                fieldId: 'payments_payment_method',
+                tableName: 'payments',
+            },
+            tileTargets: {},
+            disabled: false,
+            values: ['credit_card'],
+        };
+        it('should create no tile targets when there are no overrides', async () => {
+            expect(compressDashboardFiltersToParam({
+                dimensions: [DUMMY_DIMENSION],
+                metrics: [],
+                tableCalculations: [],
+            })).toEqual({
+                dimensions: [
+                    {
+                        id: 'filter-id',
+                        label: 'A label',
+                        operator: 'equals',
+                        target: {
+                            fieldId: 'payments_payment_method',
+                            tableName: 'payments',
+                        },
+                        tileTargets: [],
+                        disabled: false,
+                        values: ['credit_card'],
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            });
+        });
+        it('should set tile target to "false" when tile is disabled', async () => {
+            expect(compressDashboardFiltersToParam({
+                dimensions: [
+                    {
+                        ...DUMMY_DIMENSION,
+                        tileTargets: { 'chart-id-no-filter': false },
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            }).dimensions[0].tileTargets).toEqual([{ 'chart-id-no-filter': false }]);
+        });
+        it('should set tile target overrides when filter fields dont match tile fields', async () => {
+            expect(compressDashboardFiltersToParam({
+                dimensions: [
+                    {
+                        ...DUMMY_DIMENSION,
+                        tileTargets: {
+                            'chart-id-modified-filter': {
+                                fieldId: 'a_different_field',
+                                tableName: 'a_different_table',
+                            },
+                        },
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            }).dimensions[0].tileTargets).toEqual([
+                {
+                    'chart-id-modified-filter': {
+                        fieldId: 'a_different_field',
+                        tableName: 'a_different_table',
+                    },
+                },
+            ]);
+        });
+        it('should NOT set tile targets when filter fields DO match tile fields', async () => {
+            expect(compressDashboardFiltersToParam({
+                dimensions: [
+                    {
+                        ...DUMMY_DIMENSION,
+                        tileTargets: {
+                            'chart-id': {
+                                fieldId: 'payments_payment_method',
+                                tableName: 'payments',
+                            },
+                        },
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            }).dimensions[0].tileTargets).toEqual([]);
+        });
+        it('should handle disabled, override and default cases together', async () => {
+            const compressedFilters = compressDashboardFiltersToParam({
+                dimensions: [
+                    {
+                        ...DUMMY_DIMENSION,
+                        tileTargets: {
+                            'chart-id': {
+                                fieldId: 'payments_payment_method',
+                                tableName: 'payments',
+                            },
+                            'chart-id-no-filter': false,
+                            'chart-id-modified-filter': {
+                                fieldId: 'a_different_field',
+                                tableName: 'a_different_table',
+                            },
+                            'chart-id-no-filter2': false,
+                        },
+                    },
+                ],
+                metrics: [
+                    {
+                        ...DUMMY_DIMENSION,
+                        tileTargets: {
+                            'metric-chart-id': {
+                                fieldId: 'payments_payment_method',
+                                tableName: 'payments',
+                            },
+                            'metric-chart-id-no-filter': false,
+                            'metric-chart-id-modified-filter': {
+                                fieldId: 'a_different_field',
+                                tableName: 'a_different_table',
+                            },
+                            'metric-chart-id-no-filter2': false,
+                        },
+                    },
+                ],
+                tableCalculations: [],
+            });
+            expect(compressedFilters.dimensions[0].tileTargets).toEqual([
+                { 'chart-id-no-filter': false },
+                {
+                    'chart-id-modified-filter': {
+                        fieldId: 'a_different_field',
+                        tableName: 'a_different_table',
+                    },
+                },
+                { 'chart-id-no-filter2': false },
+            ]);
+            expect(compressedFilters.metrics[0].tileTargets).toEqual([
+                { 'metric-chart-id-no-filter': false },
+                {
+                    'metric-chart-id-modified-filter': {
+                        fieldId: 'a_different_field',
+                        tableName: 'a_different_table',
+                    },
+                },
+                { 'metric-chart-id-no-filter2': false },
+            ]);
+        });
+    });
+    describe('convertDashboardFiltersParamToDashboardFilters', () => {
+        const DUMMY_URL_FILTER = {
+            id: 'url-dimension',
+            label: 'a label',
+            operator: FilterOperator.EQUALS,
+            target: {
+                fieldId: 'payments_payment_method',
+                tableName: 'payments',
+            },
+            tileTargets: [],
+            disabled: false,
+            values: ['credit_card'],
+        };
+        it('should convert filters with no tile targets', async () => {
+            expect(convertDashboardFiltersParamToDashboardFilters({
+                dimensions: [DUMMY_URL_FILTER],
+                metrics: [],
+                tableCalculations: [],
+            })).toEqual({
+                dimensions: [
+                    {
+                        id: 'url-dimension',
+                        label: 'a label',
+                        operator: 'equals',
+                        target: {
+                            fieldId: 'payments_payment_method',
+                            tableName: 'payments',
+                        },
+                        tileTargets: {},
+                        disabled: false,
+                        values: ['credit_card'],
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            });
+        });
+        it('should have modified tile targets when target modified', async () => {
+            expect(convertDashboardFiltersParamToDashboardFilters({
+                dimensions: [
+                    {
+                        ...DUMMY_URL_FILTER,
+                        tileTargets: [
+                            {
+                                'chart-id-modified-filter': {
+                                    fieldId: 'other-field',
+                                    tableName: 'other-table',
+                                },
+                            },
+                        ],
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            }).dimensions[0].tileTargets).toEqual({
+                'chart-id-modified-filter': {
+                    fieldId: 'other-field',
+                    tableName: 'other-table',
+                },
+            });
+        });
+        it('should have disabled tile targets when target is "false"', async () => {
+            expect(convertDashboardFiltersParamToDashboardFilters({
+                dimensions: [
+                    {
+                        ...DUMMY_URL_FILTER,
+                        tileTargets: [{ 'chart-id-no-filter': false }],
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            }).dimensions[0].tileTargets).toEqual({ 'chart-id-no-filter': false });
+        });
+        it('should omit tile target string (for back-compat)', async () => {
+            expect(convertDashboardFiltersParamToDashboardFilters({
+                dimensions: [
+                    {
+                        ...DUMMY_URL_FILTER,
+                        tileTargets: ['an-id'],
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            }).dimensions[0].tileTargets).toEqual({});
+        });
+        it('should handle normal, modified and disabled tile targets', async () => {
+            expect(convertDashboardFiltersParamToDashboardFilters({
+                dimensions: [
+                    {
+                        ...DUMMY_URL_FILTER,
+                        tileTargets: [
+                            'an-id',
+                            { 'chart-id-no-filter': false },
+                            'another-id',
+                            {
+                                'chart-id-modified-filter': {
+                                    fieldId: 'other-field',
+                                    tableName: 'other-table',
+                                },
+                            },
+                        ],
+                    },
+                ],
+                metrics: [],
+                tableCalculations: [],
+            }).dimensions[0].tileTargets).toEqual({
+                'chart-id-no-filter': false,
+                'chart-id-modified-filter': {
+                    fieldId: 'other-field',
+                    tableName: 'other-table',
+                },
+            });
+        });
+    });
+});
+describe('removeFieldFromFilterGroup', () => {
+    const fieldToBeRemoved = 'metric_field_id_1';
+    const filterGroup = {
+        id: 'metric_id_1',
+        and: [
+            {
+                id: 'metric_uuid_1',
+                target: {
+                    fieldId: fieldToBeRemoved,
+                },
+                operator: FilterOperator.EQUALS,
+                values: ['metric_value_1'],
+            },
+            {
+                id: 'metric_id_2',
+                and: [
+                    {
+                        id: 'metric_uuid_2',
+                        target: {
+                            fieldId: fieldToBeRemoved,
+                        },
+                        operator: FilterOperator.EQUALS,
+                        values: ['metric_value_2'],
+                    },
+                ],
+            },
+        ],
+    };
+    it('should return empty filters', async () => {
+        const updatedFieldGroup = removeFieldFromFilterGroup(filterGroup, fieldToBeRemoved);
+        expect(updatedFieldGroup).toEqual(undefined);
+    });
+    it('should return remaining filters', async () => {
+        const remainingMetric = {
+            id: 'metric_uuid_3',
+            target: {
+                fieldId: 'metric_field_id_3',
+            },
+            operator: FilterOperator.EQUALS,
+            values: ['metric_value_3'],
+        };
+        const filterGroupWithRemainingMetrics = cloneDeep(filterGroup);
+        filterGroupWithRemainingMetrics.and[1].and.push(remainingMetric);
+        filterGroupWithRemainingMetrics.and.push(remainingMetric);
+        const updatedFieldGroup = removeFieldFromFilterGroup(filterGroupWithRemainingMetrics, fieldToBeRemoved);
+        expect(updatedFieldGroup).toEqual({
+            id: 'metric_id_1',
+            and: [
+                {
+                    id: 'metric_id_2',
+                    and: [remainingMetric],
+                },
+                remainingMetric,
+            ],
+        });
+    });
+});
+describe('isFilterRuleDefinedForFieldId', () => {
+    const fieldToBeFound1 = 'metric_field_id_1';
+    const fieldToBeFound2 = 'metric_field_id_2';
+    const fieldToBeFound3 = 'metric_field_id_3';
+    const filterGroup = {
+        id: 'metric_id_1',
+        and: [
+            {
+                id: 'metric_uuid_1',
+                target: {
+                    fieldId: fieldToBeFound1,
+                },
+                operator: FilterOperator.EQUALS,
+                values: ['metric_value_1'],
+            },
+            {
+                id: 'metric_uuid_3',
+                target: {
+                    fieldId: `${fieldToBeFound3}_to_be_found`,
+                },
+                operator: FilterOperator.EQUALS,
+                values: ['metric_value_3'],
+            },
+            {
+                id: 'metric_id_2',
+                and: [
+                    {
+                        id: 'metric_uuid_2',
+                        target: {
+                            fieldId: fieldToBeFound2,
+                        },
+                        operator: FilterOperator.EQUALS,
+                        values: ['metric_value_2'],
+                    },
+                ],
+            },
+        ],
+    };
+    it('should find', async () => {
+        expect(isFilterRuleDefinedForFieldId(filterGroup, fieldToBeFound1)).toEqual(true);
+        expect(isFilterRuleDefinedForFieldId(filterGroup, fieldToBeFound2)).toEqual(true);
+        expect(isFilterRuleDefinedForFieldId(filterGroup, 'someRandomFieldId')).toEqual(false);
+        expect(isFilterRuleDefinedForFieldId(filterGroup, fieldToBeFound3, true)).toEqual(true);
+        expect(isFilterRuleDefinedForFieldId(filterGroup, fieldToBeFound3, false)).toEqual(false);
+    });
+});
+//# sourceMappingURL=filter.test.js.map