@lightdash/common 0.1468.0 → 0.1469.0

package/dist/compiler/exploreCompiler.mock.js

@@ -1392,6 +1392,9 @@ exports.exploreWithMetricNumber = {
                     source: sourceMock,
                     isAutoGenerated: false,
                     hidden: false,
+                    spotlight: {
+                        visibility: 'hide',
+                    },
                 },
                 m2: {
                     fieldType: field_1.FieldType.METRIC,

package/dist/compiler/translator.js

@@ -303,7 +303,11 @@ const convertTable = (adapterType, model, dbtMetrics, spotlightConfig, startOfWe
     ]));
     const convertedDbtMetrics = Object.fromEntries(dbtMetrics.map((metric) => [
         metric.name,
-        convertDbtMetricToLightdashMetric(metric, model.name, tableLabel, spotlightConfig, model.meta.spotlight?.categories),
+        convertDbtMetricToLightdashMetric(metric, model.name, tableLabel, {
+            ...spotlightConfig,
+            default_visibility: model.meta.spotlight?.visibility ??
+                spotlightConfig.default_visibility,
+        }, model.meta.spotlight?.categories),
     ]));
     const allMetrics = Object.values({
         ...convertedDbtMetrics,

package/dist/compiler/translator.mock.d.ts

@@ -1,6 +1,7 @@
 import { type DbtMetric, type DbtModelNode, type V9MetricRef } from '../types/dbt';
 import { type Table } from '../types/explore';
 import { DimensionType } from '../types/field';
+import type { LightdashProjectConfig } from '../types/lightdashProjectConfig';
 type WarehouseCatalog = {
     [database: string]: {
         [schema: string]: {
@@ -82,4 +83,11 @@ export declare const MODEL_WITH_ADDITIONAL_DIMENSIONS: DbtModelNode & {
     relation_name: string;
 };
 export declare const LIGHTDASH_TABLE_WITH_ADDITIONAL_DIMENSIONS: Omit<Table, 'lineageGraph'>;
+export declare const SPOTLIGHT_CONFIG_WITH_CATEGORIES_AND_HIDE: LightdashProjectConfig;
+export declare const MODEL_WITH_NO_CATEGORIES: DbtModelNode;
+export declare const LIGHTDASH_TABLE_WITH_NO_CATEGORIES: Omit<Table, 'lineageGraph'>;
+export declare const MODEL_WITH_MODEL_LEVEL_CATEGORIES: DbtModelNode;
+export declare const LIGHTDASH_TABLE_WITH_MODEL_LEVEL_CATEGORIES: Omit<Table, 'lineageGraph'>;
+export declare const MODEL_WITH_METRIC_LEVEL_CATEGORIES: DbtModelNode;
+export declare const LIGHTDASH_TABLE_WITH_METRIC_LEVEL_CATEGORIES: Omit<Table, 'lineageGraph'>;
 export {};

package/dist/compiler/translator.mock.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LIGHTDASH_TABLE_WITH_ADDITIONAL_DIMENSIONS = exports.MODEL_WITH_ADDITIONAL_DIMENSIONS = exports.LIGHTDASH_TABLE_SQL_WHERE = exports.expectedModelWithType = exports.warehouseSchemaWithUpperCaseColumn = exports.warehouseSchemaWithMissingColumn = exports.warehouseSchemaWithMissingTable = exports.warehouseSchema = exports.LIGHTDASH_TABLE_WITH_CUSTOM_TIME_INTERVAL_DIMENSIONS = exports.MODEL_WITH_CUSTOM_TIME_INTERVAL_DIMENSIONS = exports.LIGHTDASH_TABLE_WITH_OFF_TIME_INTERVAL_DIMENSIONS = exports.MODEL_WITH_OFF_BOOLEAN_TIME_INTERVAL_DIMENSIONS = exports.MODEL_WITH_OFF_TIME_INTERVAL_DIMENSIONS = exports.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_SNOWFLAKE = exports.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_BIGQUERY = exports.MODEL_WITH_NO_TIME_INTERVAL_DIMENSIONS = exports.MODEL_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS = exports.LIGHTDASH_TABLE_WITH_METRICS = exports.MODEL_WITH_WRONG_METRICS = exports.MODEL_WITH_WRONG_METRIC = exports.MODEL_WITH_METRIC = exports.LIGHTDASH_TABLE_WITH_DBT_V9_METRICS = exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = exports.LIGHTDASH_TABLE_WITHOUT_AUTO_METRICS = exports.MODEL_WITH_NO_METRICS = exports.MODEL_WITH_SQL_FILTER = exports.MODEL_WITH_SQL_WHERE = exports.LIGHTDASH_TABLE_WITH_GROUP_BLOCK = exports.LIGHTDASH_TABLE_WITH_GROUP_LABEL = exports.MODEL_WITH_GROUPS_BLOCK = exports.MODEL_WITH_GROUP_LABEL = exports.BASE_LIGHTDASH_TABLE = exports.model = exports.DBT_V9_METRIC = exports.DBT_METRIC_DERIVED = exports.DBT_METRIC_WITH_CUSTOM_SQL = exports.DBT_METRIC_WITH_SQL_FIELD = exports.DBT_METRIC_WITH_FILTER = exports.DBT_METRIC = exports.INVALID_ID_COLUMN_NAMES = exports.VALID_ID_COLUMN_NAMES = void 0;
+exports.LIGHTDASH_TABLE_WITH_METRIC_LEVEL_CATEGORIES = exports.MODEL_WITH_METRIC_LEVEL_CATEGORIES = exports.LIGHTDASH_TABLE_WITH_MODEL_LEVEL_CATEGORIES = exports.MODEL_WITH_MODEL_LEVEL_CATEGORIES = exports.LIGHTDASH_TABLE_WITH_NO_CATEGORIES = exports.MODEL_WITH_NO_CATEGORIES = exports.SPOTLIGHT_CONFIG_WITH_CATEGORIES_AND_HIDE = exports.LIGHTDASH_TABLE_WITH_ADDITIONAL_DIMENSIONS = exports.MODEL_WITH_ADDITIONAL_DIMENSIONS = exports.LIGHTDASH_TABLE_SQL_WHERE = exports.expectedModelWithType = exports.warehouseSchemaWithUpperCaseColumn = exports.warehouseSchemaWithMissingColumn = exports.warehouseSchemaWithMissingTable = exports.warehouseSchema = exports.LIGHTDASH_TABLE_WITH_CUSTOM_TIME_INTERVAL_DIMENSIONS = exports.MODEL_WITH_CUSTOM_TIME_INTERVAL_DIMENSIONS = exports.LIGHTDASH_TABLE_WITH_OFF_TIME_INTERVAL_DIMENSIONS = exports.MODEL_WITH_OFF_BOOLEAN_TIME_INTERVAL_DIMENSIONS = exports.MODEL_WITH_OFF_TIME_INTERVAL_DIMENSIONS = exports.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_SNOWFLAKE = exports.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_BIGQUERY = exports.MODEL_WITH_NO_TIME_INTERVAL_DIMENSIONS = exports.MODEL_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS = exports.LIGHTDASH_TABLE_WITH_METRICS = exports.MODEL_WITH_WRONG_METRICS = exports.MODEL_WITH_WRONG_METRIC = exports.MODEL_WITH_METRIC = exports.LIGHTDASH_TABLE_WITH_DBT_V9_METRICS = exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = exports.LIGHTDASH_TABLE_WITHOUT_AUTO_METRICS = exports.MODEL_WITH_NO_METRICS = exports.MODEL_WITH_SQL_FILTER = exports.MODEL_WITH_SQL_WHERE = exports.LIGHTDASH_TABLE_WITH_GROUP_BLOCK = exports.LIGHTDASH_TABLE_WITH_GROUP_LABEL = exports.MODEL_WITH_GROUPS_BLOCK = exports.MODEL_WITH_GROUP_LABEL = exports.BASE_LIGHTDASH_TABLE = exports.model = exports.DBT_V9_METRIC = exports.DBT_METRIC_DERIVED = exports.DBT_METRIC_WITH_CUSTOM_SQL = exports.DBT_METRIC_WITH_SQL_FIELD = exports.DBT_METRIC_WITH_FILTER = exports.DBT_METRIC = exports.INVALID_ID_COLUMN_NAMES = exports.VALID_ID_COLUMN_NAMES = void 0;
 const field_1 = require("../types/field");
 const table_1 = require("../types/table");
 const timeFrames_1 = require("../types/timeFrames");
@@ -1377,3 +1377,116 @@ exports.LIGHTDASH_TABLE_WITH_ADDITIONAL_DIMENSIONS = {
         },
     },
 };
+exports.SPOTLIGHT_CONFIG_WITH_CATEGORIES_AND_HIDE = {
+    spotlight: {
+        default_visibility: 'show',
+        categories: {
+            category_1: { label: 'Category 1' },
+            category_2: { label: 'Category 2', color: 'red' },
+        },
+    },
+};
+exports.MODEL_WITH_NO_CATEGORIES = {
+    ...exports.MODEL_WITH_METRIC,
+    meta: {
+        spotlight: {
+            visibility: 'hide',
+        },
+    },
+};
+exports.LIGHTDASH_TABLE_WITH_NO_CATEGORIES = {
+    ...exports.LIGHTDASH_TABLE_WITH_METRICS,
+    metrics: {
+        ...{
+            dbt_metric_1: {
+                ...exports.LIGHTDASH_TABLE_WITH_DBT_METRICS.metrics.dbt_metric_1,
+                spotlight: {
+                    ...exports.LIGHTDASH_TABLE_WITH_DBT_METRICS.metrics.dbt_metric_1
+                        .spotlight,
+                    visibility: 'hide',
+                },
+            },
+        },
+        ...Object.fromEntries(Object.entries(exports.LIGHTDASH_TABLE_WITH_METRICS.metrics).map(([key, metric]) => [
+            key,
+            {
+                ...metric,
+                spotlight: { ...metric.spotlight, visibility: 'hide' },
+                index: (metric.index ?? 0) + 1,
+            },
+        ])),
+    },
+    dimensions: exports.LIGHTDASH_TABLE_WITH_METRICS.dimensions,
+};
+exports.MODEL_WITH_MODEL_LEVEL_CATEGORIES = {
+    ...exports.MODEL_WITH_METRIC,
+    meta: {
+        spotlight: {
+            visibility: 'hide',
+            categories: ['category_1'],
+        },
+    },
+};
+exports.LIGHTDASH_TABLE_WITH_MODEL_LEVEL_CATEGORIES = {
+    ...exports.LIGHTDASH_TABLE_WITH_NO_CATEGORIES,
+    metrics: Object.fromEntries(Object.entries(exports.LIGHTDASH_TABLE_WITH_NO_CATEGORIES.metrics).map(([key, metric]) => [
+        key,
+        {
+            ...metric,
+            spotlight: {
+                visibility: 'hide',
+                categories: ['category_1'],
+            },
+        },
+    ])),
+};
+exports.MODEL_WITH_METRIC_LEVEL_CATEGORIES = {
+    ...exports.MODEL_WITH_MODEL_LEVEL_CATEGORIES,
+    columns: {
+        user_id: {
+            name: 'user_id',
+            data_type: field_1.DimensionType.STRING,
+            meta: {
+                metrics: {
+                    user_count: {
+                        type: field_1.MetricType.COUNT_DISTINCT,
+                        spotlight: {
+                            visibility: 'hide',
+                            categories: ['category_2'],
+                        },
+                    },
+                },
+            },
+        },
+        num_participating_athletes: {
+            name: 'num_participating_athletes',
+            data_type: field_1.DimensionType.NUMBER,
+            meta: {
+                dimension: {
+                    sql: 'num_participating_men + num_participating_women',
+                },
+                metrics: {
+                    total_num_participating_athletes: {
+                        type: field_1.MetricType.SUM,
+                    },
+                },
+            },
+        },
+    },
+};
+exports.LIGHTDASH_TABLE_WITH_METRIC_LEVEL_CATEGORIES = {
+    ...exports.LIGHTDASH_TABLE_WITH_MODEL_LEVEL_CATEGORIES,
+    metrics: Object.fromEntries(Object.entries(exports.LIGHTDASH_TABLE_WITH_MODEL_LEVEL_CATEGORIES.metrics).map(([key, metric]) => [
+        key,
+        {
+            ...metric,
+            spotlight: {
+                visibility: 'hide',
+                categories: [
+                    'category_1',
+                    ...(key === 'user_count' ? ['category_2'] : []),
+                ],
+            },
+        },
+    ])),
+};

package/dist/compiler/translator.test.js

@@ -87,3 +87,17 @@ describe('convert tables from dbt models', () => {
         expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_GROUPS_BLOCK, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_GROUP_BLOCK);
     });
 });
+describe('spotlight config', () => {
+    it('should convert dbt model with metrics when no categories are defined', () => {
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_NO_CATEGORIES, [translator_mock_1.DBT_METRIC], translator_mock_1.SPOTLIGHT_CONFIG_WITH_CATEGORIES_AND_HIDE.spotlight)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_NO_CATEGORIES);
+    });
+    it('should convert dbt model with metrics when categories are defined', () => {
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_MODEL_LEVEL_CATEGORIES, [translator_mock_1.DBT_METRIC], translator_mock_1.SPOTLIGHT_CONFIG_WITH_CATEGORIES_AND_HIDE.spotlight)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_MODEL_LEVEL_CATEGORIES);
+    });
+    it('should convert dbt model with metrics when categories are defined and there is metric level assignment', () => {
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_METRIC_LEVEL_CATEGORIES, [translator_mock_1.DBT_METRIC], translator_mock_1.SPOTLIGHT_CONFIG_WITH_CATEGORIES_AND_HIDE.spotlight)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_METRIC_LEVEL_CATEGORIES);
+    });
+    it('should error when categories are assigned but not defined in the spotlight config', () => {
+        expect(() => (0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_METRIC_LEVEL_CATEGORIES, [translator_mock_1.DBT_METRIC], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toThrowError(`Invalid spotlight categories found in metric 'user_count': category_1, category_2. Categories must be defined in project config.`);
+    });
+});

package/package.json

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