@lightdash/common 0.1357.1 → 0.1359.0

package/dist/types/catalog.d.ts

@@ -24,6 +24,15 @@ export type ApiCatalogSearch = {
     filter?: CatalogFilter;
     catalogTags?: string[];
 };
+type EmojiIcon = {
+    unicode: string;
+};
+type CustomIcon = {
+    url: string;
+};
+export type CatalogItemIcon = EmojiIcon | CustomIcon;
+export declare const isEmojiIcon: (icon: CatalogItemIcon | null) => icon is EmojiIcon;
+export declare const isCustomIcon: (icon: CatalogItemIcon | null) => icon is CustomIcon;
 export type CatalogField = Pick<Field, 'name' | 'label' | 'fieldType' | 'tableLabel' | 'description'> & Pick<Dimension, 'requiredAttributes'> & {
     catalogSearchUuid: string;
     type: CatalogType.Field;
@@ -33,6 +42,7 @@ export type CatalogField = Pick<Field, 'name' | 'label' | 'fieldType' | 'tableLa
     tags?: string[];
     categories: Pick<Tag, 'name' | 'color' | 'tagUuid'>[];
     chartUsage: number | undefined;
+    icon: CatalogItemIcon | null;
 };
 export type CatalogTable = Pick<TableBase, 'name' | 'label' | 'groupLabel' | 'description' | 'requiredAttributes'> & {
     catalogSearchUuid: string;
@@ -43,6 +53,7 @@ export type CatalogTable = Pick<TableBase, 'name' | 'label' | 'groupLabel' | 'de
     categories: Pick<Tag, 'name' | 'color' | 'tagUuid'>[];
     joinedTables?: CompiledExploreJoin[];
     chartUsage: number | undefined;
+    icon: CatalogItemIcon | null;
 };
 export type CatalogItem = CatalogField | CatalogTable;
 export type ApiCatalogResults = CatalogItem[];
@@ -75,12 +86,9 @@ export type CatalogFieldMap = {
         cachedExploreUuid: string;
     };
 };
-export type CatalogItemWithTagUuids = {
-    catalogSearchUuid: string;
+export type CatalogItemWithTagUuids = Pick<CatalogItem, 'catalogSearchUuid' | 'name' | 'type'> & {
     cachedExploreUuid: string;
     projectUuid: string;
-    name: string;
-    type: CatalogType;
     fieldType?: string;
     exploreBaseTable: string;
     catalogTags: {
@@ -89,11 +97,13 @@ export type CatalogItemWithTagUuids = {
         createdAt: Date;
     }[];
 };
+export type CatalogItemsWithIcons = Pick<CatalogItem, 'catalogSearchUuid' | 'icon' | 'name' | 'type'> & Pick<CatalogItemWithTagUuids, 'cachedExploreUuid' | 'projectUuid' | 'fieldType' | 'exploreBaseTable'>;
 export type SchedulerIndexCatalogJobPayload = {
     projectUuid: string;
     explores: (Explore | ExploreError)[];
     userUuid: string;
     prevCatalogItemsWithTags: CatalogItemWithTagUuids[];
+    prevCatalogItemsWithIcons: CatalogItemsWithIcons[];
 };
 export type CatalogFieldWhere = {
     fieldName: string;
@@ -103,3 +113,4 @@ export type ChartUsageIn = CatalogFieldWhere & {
     chartUsage: number;
 };
 export declare const indexCatalogJob = "indexCatalog";
+export {};

package/dist/types/catalog.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.indexCatalogJob = exports.getBasicType = exports.CatalogFilter = exports.CatalogType = void 0;
+exports.indexCatalogJob = exports.getBasicType = exports.isCustomIcon = exports.isEmojiIcon = exports.CatalogFilter = exports.CatalogType = void 0;
 const tslib_1 = require("tslib");
 const assertUnreachable_1 = tslib_1.__importDefault(require("../utils/assertUnreachable"));
 const field_1 = require("./field");
@@ -15,6 +15,10 @@ var CatalogFilter;
     CatalogFilter["Dimensions"] = "dimensions";
     CatalogFilter["Metrics"] = "metrics";
 })(CatalogFilter = exports.CatalogFilter || (exports.CatalogFilter = {}));
+const isEmojiIcon = (icon) => Boolean(icon && 'unicode' in icon);
+exports.isEmojiIcon = isEmojiIcon;
+const isCustomIcon = (icon) => Boolean(icon && 'url' in icon);
+exports.isCustomIcon = isCustomIcon;
 const getBasicType = (field) => {
     const { type } = field;
     switch (type) {

package/dist/utils/filters.d.ts

@@ -1,3 +1,4 @@
+import { type DashboardTile } from '../types/dashboard';
 import { type Table } from '../types/explore';
 import { type CompiledField, type CustomSqlDimension, type Dimension, type Field, type FilterableDimension, type FilterableField, type FilterableItem, type ItemsMap, type TableCalculation } from '../types/field';
 import { FilterOperator, FilterType, type AndFilterGroup, type DashboardFieldTarget, type DashboardFilterRule, type DashboardFilters, type FilterDashboardToRule, type FilterGroup, type FilterGroupItem, type FilterRule, type Filters, type MetricFilterRule, type OrFilterGroup } from '../types/filter';
@@ -14,6 +15,7 @@ export declare const createFilterRuleFromField: (field: FilterableField, value?:
 export declare const matchFieldExact: (a: Field) => (b: Field) => boolean;
 export declare const matchFieldByTypeAndName: (a: Field) => (b: Field) => boolean;
 export declare const matchFieldByType: (a: Field) => (b: Field) => boolean;
+export declare const isTileFilterable: (tile: DashboardTile) => boolean;
 export declare const applyDefaultTileTargets: (filterRule: DashboardFilterRule<FilterOperator, DashboardFieldTarget, any, any>, field: FilterableDimension, availableTileFilters: Record<string, FilterableDimension[] | undefined>) => DashboardFilterRule<FilterOperator, DashboardFieldTarget, any, any>;
 export declare const createDashboardFilterRuleFromField: ({ field, availableTileFilters, isTemporary, value, }: {
     field: Exclude<FilterableItem, TableCalculation | CustomSqlDimension> | CompiledField;
@@ -43,6 +45,7 @@ export declare const isDimensionValueInvalidDate: (item: FilterableField, value:
 export declare const getFiltersFromGroup: (filterGroup: FilterGroup, fields: ItemsMap[string][]) => Filters;
 export declare const deleteFilterRuleFromGroup: (filterGroup: FilterGroup, id: string) => FilterGroup;
 export declare const getDashboardFilterRulesForTile: (tileUuid: string, rules: DashboardFilterRule[]) => DashboardFilterRule[];
+export declare const getTabUuidsForFilterRules: (dashboardTiles: DashboardTile[] | undefined, filters: DashboardFilters, filterableFieldsByTileUuid: Record<string, FilterableDimension[]> | undefined) => Record<string, string[]>;
 export declare const getDashboardFilterRulesForTables: (tables: string[], rules: DashboardFilterRule[]) => DashboardFilterRule[];
 export declare const getDashboardFilterRulesForTileAndTables: (tileUuid: string, tables: string[], rules: DashboardFilterRule[]) => DashboardFilterRule[];
 export declare const getDashboardFiltersForTileAndTables: (tileUuid: string, tables: string[], dashboardFilters: DashboardFilters) => DashboardFilters;

package/dist/utils/filters.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resetRequiredFilterRules = exports.reduceRequiredDimensionFiltersToFilterRules = exports.isFilterRuleInQuery = exports.createFilterRuleFromRequiredMetricRule = exports.addDashboardFiltersToMetricQuery = exports.overrideFilterGroupWithFilterRules = exports.overrideChartFilter = exports.addFiltersToMetricQuery = exports.getDashboardFiltersForTileAndTables = exports.getDashboardFilterRulesForTileAndTables = exports.getDashboardFilterRulesForTables = exports.getDashboardFilterRulesForTile = exports.deleteFilterRuleFromGroup = exports.getFiltersFromGroup = exports.isDimensionValueInvalidDate = exports.addFilterRule = exports.createDashboardFilterRuleFromField = exports.applyDefaultTileTargets = exports.matchFieldByType = exports.matchFieldByTypeAndName = exports.matchFieldExact = exports.createFilterRuleFromField = exports.getFilterRuleWithDefaultValue = exports.getFilterTypeFromItem = exports.getFilterGroupItemsPropertyName = exports.getItemsFromFilterGroup = exports.hasNestedGroups = exports.countTotalFilterRules = exports.getTotalFilterRules = exports.getFilterRulesFromGroup = void 0;
+exports.resetRequiredFilterRules = exports.reduceRequiredDimensionFiltersToFilterRules = exports.isFilterRuleInQuery = exports.createFilterRuleFromRequiredMetricRule = exports.addDashboardFiltersToMetricQuery = exports.overrideFilterGroupWithFilterRules = exports.overrideChartFilter = exports.addFiltersToMetricQuery = exports.getDashboardFiltersForTileAndTables = exports.getDashboardFilterRulesForTileAndTables = exports.getDashboardFilterRulesForTables = exports.getTabUuidsForFilterRules = exports.getDashboardFilterRulesForTile = exports.deleteFilterRuleFromGroup = exports.getFiltersFromGroup = exports.isDimensionValueInvalidDate = exports.addFilterRule = exports.createDashboardFilterRuleFromField = exports.applyDefaultTileTargets = exports.isTileFilterable = exports.matchFieldByType = exports.matchFieldByTypeAndName = exports.matchFieldExact = exports.createFilterRuleFromField = exports.getFilterRuleWithDefaultValue = exports.getFilterTypeFromItem = exports.getFilterGroupItemsPropertyName = exports.getItemsFromFilterGroup = exports.hasNestedGroups = exports.countTotalFilterRules = exports.getTotalFilterRules = exports.getFilterRulesFromGroup = void 0;
 const tslib_1 = require("tslib");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const moment_1 = tslib_1.__importDefault(require("moment"));
 const uuid_1 = require("uuid");
+const dashboard_1 = require("../types/dashboard");
 const field_1 = require("../types/field");
 const filter_1 = require("../types/filter");
 const timeFrames_1 = require("../types/timeFrames");
@@ -182,6 +183,8 @@ const matchFieldByTypeAndName = (a) => (b) => a.type === b.type && a.name === b.
 exports.matchFieldByTypeAndName = matchFieldByTypeAndName;
 const matchFieldByType = (a) => (b) => a.type === b.type;
 exports.matchFieldByType = matchFieldByType;
+const isTileFilterable = (tile) => ![dashboard_1.DashboardTileTypes.MARKDOWN, dashboard_1.DashboardTileTypes.LOOM].includes(tile.type);
+exports.isTileFilterable = isTileFilterable;
 const getDefaultTileTargets = (field, availableTileFilters) => Object.entries(availableTileFilters).reduce((acc, [tileUuid, availableFilters]) => {
     if (!availableFilters)
         return acc;
@@ -409,6 +412,37 @@ const getDashboardFilterRulesForTile = (tileUuid, rules) => rules
 })
     .filter((f) => f !== null);
 exports.getDashboardFilterRulesForTile = getDashboardFilterRulesForTile;
+const getTabUuidsForFilterRules = (dashboardTiles, filters, filterableFieldsByTileUuid) => {
+    if (!dashboardTiles)
+        return {};
+    return dashboardTiles.reduce((acc, tile) => {
+        if (!tile.tabUuid || !(0, exports.isTileFilterable)(tile)) {
+            return acc;
+        }
+        const filterIdsForTile = (0, exports.getDashboardFilterRulesForTile)(tile.uuid, filters.dimensions)
+            .filter((filterRule) => {
+            const tileConfig = filterRule.tileTargets?.[tile.uuid];
+            // TODO: Move this fallback logic to the getDashboardFilterRulesForTile function
+            if (tileConfig === undefined && filterableFieldsByTileUuid) {
+                return filterableFieldsByTileUuid[tile.uuid]?.some((f) => (0, item_1.getItemId)(f) === filterRule.target.fieldId);
+            }
+            // Apply filter to tile
+            return !!tileConfig;
+        })
+            .map((tileFilter) => tileFilter.id);
+        // Set filter id as key and tile tab uuids as values
+        filterIdsForTile.forEach((filterId) => {
+            if (!acc[filterId]) {
+                acc[filterId] = [];
+            }
+            if (tile.tabUuid && !acc[filterId].includes(tile.tabUuid)) {
+                acc[filterId].push(tile.tabUuid);
+            }
+        });
+        return acc;
+    }, {});
+};
+exports.getTabUuidsForFilterRules = getTabUuidsForFilterRules;
 const getDashboardFilterRulesForTables = (tables, rules) => rules.filter((f) => tables.includes(f.target.tableName));
 exports.getDashboardFilterRulesForTables = getDashboardFilterRulesForTables;
 const getDashboardFilterRulesForTileAndTables = (tileUuid, tables, rules) => (0, exports.getDashboardFilterRulesForTables)(tables, (0, exports.getDashboardFilterRulesForTile)(tileUuid, rules));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lightdash/common",
-    "version": "0.1357.1",
+    "version": "0.1359.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "files": [