@lightdash/common 0.1462.1 → 0.1463.0

package/dist/compiler/exploreCompiler.d.ts

@@ -1,8 +1,9 @@
-import { type SupportedDbtAdapter } from '../types/dbt';
+import { type DbtRawModelNode, type SupportedDbtAdapter } from '../types/dbt';
 import { type CompiledExploreJoin, type CompiledTable, type Explore, type ExploreJoin, type Table } from '../types/explore';
 import { type CompiledCustomDimension, type CompiledCustomSqlDimension, type CompiledDimension, type CompiledMetric, type CustomDimension, type CustomSqlDimension, type Dimension, type Metric } from '../types/field';
 import { type WarehouseClient } from '../types/warehouse';
 import { type DateGranularity } from '../types/timeFrames';
+import { type LightdashProjectConfig } from '../types/lightdashProjectConfig';
 export declare const lightdashVariablePattern: RegExp;
 type Reference = {
     refTable: string;
@@ -24,11 +25,13 @@ export type UncompiledExplore = {
     ymlPath?: string;
     sqlPath?: string;
     joinAliases?: Record<string, Record<string, string>>;
+    spotlightConfig?: LightdashProjectConfig['spotlight'];
+    meta: DbtRawModelNode['meta'];
 };
 export declare class ExploreCompiler {
     private readonly warehouseClient;
     constructor(warehouseClient: WarehouseClient);
-    compileExplore({ name, label, tags, baseTable, joinedTables, tables, targetDatabase, groupLabel, warehouse, ymlPath, sqlPath, }: UncompiledExplore): Explore;
+    compileExplore({ name, label, tags, baseTable, joinedTables, tables, targetDatabase, groupLabel, warehouse, ymlPath, sqlPath, spotlightConfig, meta, }: UncompiledExplore): Explore;
     compileTable(table: Table, tables: Record<string, Table>): CompiledTable;
     compileMetric(metric: Metric, tables: Record<string, Table>): CompiledMetric;
     compileMetricSql(metric: Metric, tables: Record<string, Table>): {

package/dist/compiler/exploreCompiler.js

@@ -33,7 +33,7 @@ class ExploreCompiler {
     constructor(warehouseClient) {
         this.warehouseClient = warehouseClient;
     }
-    compileExplore({ name, label, tags, baseTable, joinedTables, tables, targetDatabase, groupLabel, warehouse, ymlPath, sqlPath, }) {
+    compileExplore({ name, label, tags, baseTable, joinedTables, tables, targetDatabase, groupLabel, warehouse, ymlPath, sqlPath, spotlightConfig, meta, }) {
         // Check that base table and joined tables exist
         if (!tables[baseTable]) {
             throw new errors_1.CompileError(`Failed to compile explore "${name}". Tried to find base table but cannot find table with name "${baseTable}"`, {});
@@ -118,7 +118,15 @@ class ExploreCompiler {
             [tableName]: this.compileTable(includedTables[tableName], includedTables),
         }), {});
         const compiledJoins = joinedTables.map((j) => this.compileJoin(j, includedTables));
+        const spotlightVisibility = meta.spotlight?.visibility ?? spotlightConfig?.default_visibility;
         return {
+            ...(spotlightVisibility !== undefined
+                ? {
+                    spotlight: {
+                        visibility: spotlightVisibility,
+                    },
+                }
+                : {}),
             name,
             label,
             tags,

package/dist/compiler/exploreCompiler.mock.js

@@ -5,6 +5,7 @@ exports.expectedCompiledCustomSqlDimensionWithReferences = void 0;
 const dbt_1 = require("../types/dbt");
 const field_1 = require("../types/field");
 const filter_1 = require("../types/filter");
+const lightdashProjectConfig_1 = require("../types/lightdashProjectConfig");
 const timeFrames_1 = require("../types/timeFrames");
 exports.warehouseClientMock = {
     credentials: {},
@@ -78,6 +79,9 @@ exports.exploreBase = {
     name: '',
     label: '',
     tags: [],
+    spotlight: {
+        visibility: 'show',
+    },
     baseTable: 'a',
     joinedTables: [],
     tables: {},
@@ -88,6 +92,8 @@ exports.exploreBase = {
 };
 exports.exploreOneEmptyTable = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     tables: {
         a: {
             name: 'a',
@@ -125,9 +131,13 @@ exports.exploreOneEmptyTableCompiled = {
 };
 exports.exploreMissingBaseTable = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
 };
 exports.exploreMissingJoinTable = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     joinedTables: [
         {
             table: 'b',
@@ -152,6 +162,8 @@ exports.exploreMissingJoinTable = {
 };
 exports.exploreCircularDimensionReference = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     tables: {
         a: {
             name: 'a',
@@ -197,6 +209,8 @@ exports.exploreCircularDimensionShortReference = {
 };
 exports.exploreCircularMetricReference = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     tables: {
         a: {
             name: 'a',
@@ -254,6 +268,8 @@ exports.exploreCircularMetricShortReference = {
 };
 exports.exploreTableSelfReference = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     tables: {
         a: {
             name: 'a',
@@ -284,6 +300,8 @@ exports.exploreTableSelfReference = {
 };
 exports.exploreTableSelfReferenceSqlWhere = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     tables: {
         a: {
             name: 'a',
@@ -380,6 +398,8 @@ exports.exploreTableSelfReferenceCompiledSqlWhere = {
 };
 exports.exploreReferenceDimension = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     tables: {
         a: {
             name: 'a',
@@ -467,6 +487,8 @@ exports.exploreReferenceDimensionCompiled = {
 };
 exports.exploreComplexReference = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     tables: {
         a: {
             name: 'a',
@@ -606,6 +628,8 @@ exports.exploreComplexReferenceCompiled = {
 };
 exports.simpleJoinedExplore = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     joinedTables: [
         {
             table: 'b',
@@ -1332,6 +1356,8 @@ exports.compiledJoinedExploreWithJoinAliasAndSubsetOfFieldsThatDontIncludeSqlFie
 };
 exports.exploreWithMetricNumber = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     tables: {
         a: {
             name: 'a',
@@ -1386,7 +1412,18 @@ exports.exploreWithMetricNumber = {
     },
 };
 exports.exploreWithMetricNumberCompiled = {
-    ...exports.exploreWithMetricNumber,
+    name: exports.exploreWithMetricNumber.name,
+    label: exports.exploreWithMetricNumber.label,
+    baseTable: exports.exploreWithMetricNumber.baseTable,
+    tags: exports.exploreWithMetricNumber.tags,
+    targetDatabase: exports.exploreWithMetricNumber.targetDatabase,
+    warehouse: exports.exploreWithMetricNumber.warehouse,
+    ymlPath: exports.exploreWithMetricNumber.ymlPath,
+    sqlPath: exports.exploreWithMetricNumber.sqlPath,
+    groupLabel: exports.exploreWithMetricNumber.groupLabel,
+    spotlight: {
+        visibility: 'show',
+    },
     joinedTables: [],
     tables: {
         a: {
@@ -1567,6 +1604,8 @@ exports.tablesWithMetricsWithFilters = {
 };
 exports.exploreWithRequiredAttributes = {
     ...exports.exploreBase,
+    spotlightConfig: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+    meta: {},
     joinedTables: [
         {
             table: 'b',

package/dist/compiler/translator.d.ts

@@ -1,10 +1,11 @@
 import { SupportedDbtAdapter, type DbtMetric, type DbtModelNode } from '../types/dbt';
 import { type Explore, type ExploreError, type Table } from '../types/explore';
 import { DimensionType } from '../types/field';
+import { type LightdashProjectConfig } from '../types/lightdashProjectConfig';
 import { type WarehouseClient } from '../types/warehouse';
 import { type WeekDay } from '../utils/timeFrames';
-export declare const convertTable: (adapterType: SupportedDbtAdapter, model: DbtModelNode, dbtMetrics: DbtMetric[], startOfWeek?: WeekDay | null) => Omit<Table, 'lineageGraph'>;
-export declare const convertExplores: (models: DbtModelNode[], loadSources: boolean, adapterType: SupportedDbtAdapter, metrics: DbtMetric[], warehouseClient: WarehouseClient) => Promise<(Explore | ExploreError)[]>;
+export declare const convertTable: (adapterType: SupportedDbtAdapter, model: DbtModelNode, dbtMetrics: DbtMetric[], spotlightConfig: LightdashProjectConfig['spotlight'], startOfWeek?: WeekDay | null) => Omit<Table, 'lineageGraph'>;
+export declare const convertExplores: (models: DbtModelNode[], loadSources: boolean, adapterType: SupportedDbtAdapter, metrics: DbtMetric[], warehouseClient: WarehouseClient, lightdashProjectConfig: LightdashProjectConfig) => Promise<(Explore | ExploreError)[]>;
 export declare const attachTypesToModels: (models: DbtModelNode[], warehouseCatalog: {
     [database: string]: {
         [schema: string]: {

package/dist/compiler/translator.js

@@ -118,7 +118,7 @@ const generateTableLineage = (model, depGraph) => {
             .map((d) => depGraph.getNodeData(d)),
     }), {});
 };
-const convertDbtMetricToLightdashMetric = (metric, tableName, tableLabel) => {
+const convertDbtMetricToLightdashMetric = (metric, tableName, tableLabel, spotlightConfig) => {
     let sql;
     let type;
     if (metric.calculation_method === 'derived') {
@@ -161,6 +161,7 @@ const convertDbtMetricToLightdashMetric = (metric, tableName, tableLabel) => {
         sql = `CASE WHEN ${filterSql} THEN ${sql} ELSE NULL END`;
     }
     const groups = (0, dbt_1.convertToGroups)(metric.meta?.groups, metric.meta?.group_label);
+    const spotlightVisibility = spotlightConfig?.default_visibility;
     return {
         fieldType: field_1.FieldType.METRIC,
         type,
@@ -188,9 +189,16 @@ const convertDbtMetricToLightdashMetric = (metric, tableName, tableLabel) => {
                     : [metric.meta.tags],
             }
             : {}),
+        ...(spotlightVisibility !== undefined
+            ? {
+                spotlight: {
+                    visibility: spotlightVisibility,
+                },
+            }
+            : {}),
     };
 };
-const convertTable = (adapterType, model, dbtMetrics, startOfWeek) => {
+const convertTable = (adapterType, model, dbtMetrics, spotlightConfig, startOfWeek) => {
     const meta = model.config?.meta || model.meta; // Config block takes priority, then meta block
     const tableLabel = meta.label || (0, field_1.friendlyName)(model.name);
     const [dimensions, metrics] = Object.values(model.columns).reduce(([prevDimensions, prevMetrics], column, index) => {
@@ -264,7 +272,12 @@ const convertTable = (adapterType, model, dbtMetrics, startOfWeek) => {
                 name,
                 metric,
                 tableLabel,
-                requiredAttributes: dimension.requiredAttributes, // TODO Join dimension required_attributes with metric required_attributes
+                requiredAttributes: dimension.requiredAttributes,
+                spotlightConfig: {
+                    ...spotlightConfig,
+                    default_visibility: model.meta.spotlight?.visibility ??
+                        spotlightConfig.default_visibility,
+                },
             }),
         ]));
         return [
@@ -283,11 +296,16 @@ const convertTable = (adapterType, model, dbtMetrics, startOfWeek) => {
             name,
             metric,
             tableLabel,
+            spotlightConfig: {
+                ...spotlightConfig,
+                default_visibility: model.meta.spotlight?.visibility ??
+                    spotlightConfig?.default_visibility,
+            },
         }),
     ]));
     const convertedDbtMetrics = Object.fromEntries(dbtMetrics.map((metric) => [
         metric.name,
-        convertDbtMetricToLightdashMetric(metric, model.name, tableLabel),
+        convertDbtMetricToLightdashMetric(metric, model.name, tableLabel, spotlightConfig),
     ]));
     const allMetrics = Object.values({
         ...convertedDbtMetrics,
@@ -374,7 +392,7 @@ const modelCanUseMetric = (metricName, modelName, metrics) => {
     }
     return false;
 };
-const convertExplores = async (models, loadSources, adapterType, metrics, warehouseClient) => {
+const convertExplores = async (models, loadSources, adapterType, metrics, warehouseClient, lightdashProjectConfig) => {
     const tableLineage = translateDbtModelsToTableLineage(models);
     const [tables, exploreErrors] = models.reduce(([accTables, accErrors], model) => {
         const meta = model.config?.meta || model.meta; // Config block takes priority, then meta block
@@ -382,7 +400,7 @@ const convertExplores = async (models, loadSources, adapterType, metrics, wareho
         try {
             // base dimensions and metrics
             const tableMetrics = metrics.filter((metric) => modelCanUseMetric(metric.name, model.name, metrics));
-            const table = (0, exports.convertTable)(adapterType, model, tableMetrics, warehouseClient.getStartOfWeek());
+            const table = (0, exports.convertTable)(adapterType, model, tableMetrics, lightdashProjectConfig.spotlight, warehouseClient.getStartOfWeek());
             // add sources
             if (loadSources && model.patch_path !== null) {
                 throw new Error('Not Implemented');
@@ -441,6 +459,8 @@ const convertExplores = async (models, loadSources, adapterType, metrics, wareho
                 warehouse: model.config?.snowflake_warehouse,
                 ymlPath: model.patch_path?.split('://')?.[1],
                 sqlPath: model.path,
+                spotlightConfig: lightdashProjectConfig.spotlight,
+                meta,
             });
         }
         catch (e) {

package/dist/compiler/translator.mock.js

@@ -317,6 +317,9 @@ exports.LIGHTDASH_TABLE_WITH_GROUP_BLOCK = {
             table: 'myTable',
             tableLabel: 'My table',
             type: field_1.MetricType.COUNT_DISTINCT,
+            spotlight: {
+                visibility: 'show',
+            },
         },
     },
     groupDetails: {
@@ -394,6 +397,9 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             groups: [],
             filters: [],
             index: 0,
+            spotlight: {
+                visibility: 'show',
+            },
         },
         dbt_metric_2: {
             description: 'Description',
@@ -415,6 +421,9 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             groups: [],
             filters: [],
             index: 1,
+            spotlight: {
+                visibility: 'show',
+            },
         },
         dbt_metric_3: {
             description: 'Description',
@@ -436,6 +445,9 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             groups: [],
             filters: [],
             index: 2,
+            spotlight: {
+                visibility: 'show',
+            },
         },
         dbt_metric_4: {
             description: 'Description',
@@ -457,6 +469,9 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             groups: [],
             filters: [],
             index: 3,
+            spotlight: {
+                visibility: 'show',
+            },
         },
         dbt_metric_5: {
             description: 'Description',
@@ -478,6 +493,9 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             groups: [],
             filters: [],
             index: 4,
+            spotlight: {
+                visibility: 'show',
+            },
         },
     },
 };
@@ -504,6 +522,9 @@ exports.LIGHTDASH_TABLE_WITH_DBT_V9_METRICS = {
             groups: [],
             filters: [],
             index: 0,
+            spotlight: {
+                visibility: 'show',
+            },
         },
     },
 };
@@ -626,6 +647,9 @@ exports.LIGHTDASH_TABLE_WITH_METRICS = {
             index: 0,
             dimensionReference: 'myTable_user_id',
             requiredAttributes: undefined,
+            spotlight: {
+                visibility: 'show',
+            },
         },
         total_num_participating_athletes: {
             fieldType: field_1.FieldType.METRIC,
@@ -649,6 +673,9 @@ exports.LIGHTDASH_TABLE_WITH_METRICS = {
             index: 1,
             dimensionReference: 'myTable_num_participating_athletes',
             requiredAttributes: undefined,
+            spotlight: {
+                visibility: 'show',
+            },
         },
     },
 };

package/dist/compiler/translator.test.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const dbt_1 = require("../types/dbt");
+const lightdashProjectConfig_1 = require("../types/lightdashProjectConfig");
 const translator_1 = require("./translator");
 const translator_mock_1 = require("./translator.mock");
 describe('attachTypesToModels', () => {
@@ -26,7 +27,7 @@ describe('attachTypesToModels', () => {
 });
 describe('convert tables from dbt models', () => {
     it('should convert dbt model without metrics to Lightdash table without autogenerated metrics', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_NO_METRICS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITHOUT_AUTO_METRICS);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_NO_METRICS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITHOUT_AUTO_METRICS);
     });
     it('should convert dbt model with dbt metrics', () => {
         expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_NO_METRICS, [
@@ -35,56 +36,54 @@ describe('convert tables from dbt models', () => {
             translator_mock_1.DBT_METRIC_WITH_CUSTOM_SQL,
             translator_mock_1.DBT_METRIC_WITH_FILTER,
             translator_mock_1.DBT_METRIC_DERIVED,
-        ])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DBT_METRICS);
+        ], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DBT_METRICS);
         // dbt 1.5 metrics
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_NO_METRICS, [
-            translator_mock_1.DBT_V9_METRIC,
-        ])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DBT_V9_METRICS);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_NO_METRICS, [translator_mock_1.DBT_V9_METRIC], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DBT_V9_METRICS);
     });
     it('should convert dbt model with metrics in meta', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_METRIC, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_METRICS);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_METRIC, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_METRICS);
     });
     it('should convert dbt model with dimension with default time intervals bigquery', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_BIGQUERY);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_BIGQUERY);
     });
     it('should convert dbt model with dimension with no time intervals bigquery', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_NO_TIME_INTERVAL_DIMENSIONS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_BIGQUERY);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_NO_TIME_INTERVAL_DIMENSIONS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_BIGQUERY);
     });
     it('should convert dbt model with dimension with default time intervals snowflake', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.SNOWFLAKE, translator_mock_1.MODEL_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_SNOWFLAKE);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.SNOWFLAKE, translator_mock_1.MODEL_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_SNOWFLAKE);
     });
     it('should convert dbt model with dimension with no time intervals snowflake', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.SNOWFLAKE, translator_mock_1.MODEL_WITH_NO_TIME_INTERVAL_DIMENSIONS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_SNOWFLAKE);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.SNOWFLAKE, translator_mock_1.MODEL_WITH_NO_TIME_INTERVAL_DIMENSIONS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_DEFAULT_TIME_INTERVAL_DIMENSIONS_SNOWFLAKE);
     });
     it('should convert dbt model with dimension with off time intervals', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_OFF_TIME_INTERVAL_DIMENSIONS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_OFF_TIME_INTERVAL_DIMENSIONS);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_OFF_TIME_INTERVAL_DIMENSIONS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_OFF_TIME_INTERVAL_DIMENSIONS);
     });
     it('should convert dbt model with dimension with off boolean time intervals', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_OFF_BOOLEAN_TIME_INTERVAL_DIMENSIONS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_OFF_TIME_INTERVAL_DIMENSIONS);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_OFF_BOOLEAN_TIME_INTERVAL_DIMENSIONS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_OFF_TIME_INTERVAL_DIMENSIONS);
     });
     it('should convert dbt model with dimension with custom time intervals', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_CUSTOM_TIME_INTERVAL_DIMENSIONS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_CUSTOM_TIME_INTERVAL_DIMENSIONS);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_CUSTOM_TIME_INTERVAL_DIMENSIONS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_CUSTOM_TIME_INTERVAL_DIMENSIONS);
     });
     it('should throw an error when metric and dimension have the same name', async () => {
-        expect(() => (0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_WRONG_METRIC, [])).toThrowError('Found a metric and a dimension with the same name: user_id');
+        expect(() => (0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_WRONG_METRIC, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toThrowError('Found a metric and a dimension with the same name: user_id');
     });
     it('should throw an error when multiple metrics and dimensions have the same name', async () => {
-        expect(() => (0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_WRONG_METRICS, [])).toThrowError('Found multiple metrics and a dimensions with the same name: user_id,user_id2');
+        expect(() => (0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_WRONG_METRICS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toThrowError('Found multiple metrics and a dimensions with the same name: user_id,user_id2');
     });
     it('should convert dbt model with group label', async () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_GROUP_LABEL, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_GROUP_LABEL);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_GROUP_LABEL, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_GROUP_LABEL);
     });
     // `sql_where` is an alias of `sql_filter`
     it('should convert dbt model with sql where', async () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_SQL_WHERE, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_SQL_WHERE);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_SQL_WHERE, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_SQL_WHERE);
     });
     it('should convert dbt model with sql filter', async () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_SQL_FILTER, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_SQL_WHERE);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_SQL_FILTER, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_SQL_WHERE);
     });
     it('should convert dbt model with dimension and additional dimensions', () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.POSTGRES, translator_mock_1.MODEL_WITH_ADDITIONAL_DIMENSIONS, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_ADDITIONAL_DIMENSIONS);
+        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.POSTGRES, translator_mock_1.MODEL_WITH_ADDITIONAL_DIMENSIONS, [], lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG)).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_ADDITIONAL_DIMENSIONS);
     });
     it('should convert dbt model with groups meta block', async () => {
-        expect((0, translator_1.convertTable)(dbt_1.SupportedDbtAdapter.BIGQUERY, translator_mock_1.MODEL_WITH_GROUPS_BLOCK, [])).toStrictEqual(translator_mock_1.LIGHTDASH_TABLE_WITH_GROUP_BLOCK);
+        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);
     });
 });

package/dist/index.d.ts

@@ -54,6 +54,7 @@ export * from './compiler/translator';
 export * from './dbt/validation';
 export * from './pivotTable/pivotQueryResults';
 export { default as lightdashDbtYamlSchema } from './schemas/json/lightdash-dbt-2.0.json';
+export { default as lightdashProjectConfigSchema } from './schemas/json/lightdash-project-config-1.0.json';
 export * from './templating/template';
 export * from './types/analytics';
 export * from './types/api';
@@ -88,6 +89,7 @@ export * from './types/gitIntegration';
 export * from './types/groups';
 export * from './types/job';
 export * from './types/knex-paginate';
+export * from './types/lightdashProjectConfig';
 export * from './types/metricQuery';
 export * from './types/metricsExplorer';
 export * from './types/notifications';
@@ -152,6 +154,7 @@ export * from './visualizations/TableDataModel';
 export * from './visualizations/types';
 export * from './visualizations/types/IResultsRunner';
 export * from './types/spotlightTableConfig';
+export * from './utils/loadLightdashProjectConfig';
 export declare const validateEmail: (email: string) => boolean;
 export declare const getEmailSchema: () => z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
 export declare const getPasswordSchema: () => z.ZodString;

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProjectDirectory = exports.deepEqual = exports.removeEmptyProperties = exports.formatRows = exports.itemsInMetricQuery = exports.getTableCalculationsFromItemsMap = exports.getMetricsFromItemsMap = exports.getFilterableDimensionsFromItemsMap = exports.getDimensionsFromItemsMap = exports.getItemMap = exports.getFieldMap = exports.getAxisName = exports.getDateGroupLabel = exports.getResultValueArray = exports.DbtProjectTypeLabels = exports.sensitiveDbtCredentialsFieldNames = exports.DBFieldTypes = exports.LightdashInstallType = exports.isLightdashMode = exports.LightdashMode = exports.isApiError = exports.hasInviteCode = exports.TableSelectionType = exports.hasSpecialCharacters = exports.snakeCaseName = exports.findFieldByIdInExplore = exports.getVisibleFields = exports.SEED_GROUP = exports.SEED_SPACE = exports.SEED_PROJECT = exports.SEED_ORG_2_ADMIN_PASSWORD = exports.SEED_ORG_2_ADMIN_EMAIL = exports.SEED_ORG_2_ADMIN = exports.SEED_ORG_2 = exports.SEED_ORG_1_ADMIN_PASSWORD = exports.SEED_ORG_1_ADMIN_EMAIL = exports.SEED_ORG_1_ADMIN = exports.SEED_ORG_1 = exports.hexToRGB = exports.replaceStringInArray = exports.toggleArrayValue = exports.hasIntersection = exports.validatePassword = exports.getPasswordSchema = exports.getEmailSchema = exports.validateEmail = exports.assertUnreachable = exports.lightdashDbtYamlSchema = void 0;
+exports.getProjectDirectory = exports.deepEqual = exports.removeEmptyProperties = exports.formatRows = exports.itemsInMetricQuery = exports.getTableCalculationsFromItemsMap = exports.getMetricsFromItemsMap = exports.getFilterableDimensionsFromItemsMap = exports.getDimensionsFromItemsMap = exports.getItemMap = exports.getFieldMap = exports.getAxisName = exports.getDateGroupLabel = exports.getResultValueArray = exports.DbtProjectTypeLabels = exports.sensitiveDbtCredentialsFieldNames = exports.DBFieldTypes = exports.LightdashInstallType = exports.isLightdashMode = exports.LightdashMode = exports.isApiError = exports.hasInviteCode = exports.TableSelectionType = exports.hasSpecialCharacters = exports.snakeCaseName = exports.findFieldByIdInExplore = exports.getVisibleFields = exports.SEED_GROUP = exports.SEED_SPACE = exports.SEED_PROJECT = exports.SEED_ORG_2_ADMIN_PASSWORD = exports.SEED_ORG_2_ADMIN_EMAIL = exports.SEED_ORG_2_ADMIN = exports.SEED_ORG_2 = exports.SEED_ORG_1_ADMIN_PASSWORD = exports.SEED_ORG_1_ADMIN_EMAIL = exports.SEED_ORG_1_ADMIN = exports.SEED_ORG_1 = exports.hexToRGB = exports.replaceStringInArray = exports.toggleArrayValue = exports.hasIntersection = exports.validatePassword = exports.getPasswordSchema = exports.getEmailSchema = exports.validateEmail = exports.assertUnreachable = exports.lightdashProjectConfigSchema = exports.lightdashDbtYamlSchema = void 0;
 const tslib_1 = require("tslib");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const utc_1 = tslib_1.__importDefault(require("dayjs/plugin/utc"));
@@ -22,6 +22,8 @@ tslib_1.__exportStar(require("./dbt/validation"), exports);
 tslib_1.__exportStar(require("./pivotTable/pivotQueryResults"), exports);
 var lightdash_dbt_2_0_json_1 = require("./schemas/json/lightdash-dbt-2.0.json");
 Object.defineProperty(exports, "lightdashDbtYamlSchema", { enumerable: true, get: function () { return tslib_1.__importDefault(lightdash_dbt_2_0_json_1).default; } });
+var lightdash_project_config_1_0_json_1 = require("./schemas/json/lightdash-project-config-1.0.json");
+Object.defineProperty(exports, "lightdashProjectConfigSchema", { enumerable: true, get: function () { return tslib_1.__importDefault(lightdash_project_config_1_0_json_1).default; } });
 tslib_1.__exportStar(require("./templating/template"), exports);
 tslib_1.__exportStar(require("./types/analytics"), exports);
 tslib_1.__exportStar(require("./types/api"), exports);
@@ -56,6 +58,7 @@ tslib_1.__exportStar(require("./types/gitIntegration"), exports);
 tslib_1.__exportStar(require("./types/groups"), exports);
 tslib_1.__exportStar(require("./types/job"), exports);
 tslib_1.__exportStar(require("./types/knex-paginate"), exports);
+tslib_1.__exportStar(require("./types/lightdashProjectConfig"), exports);
 tslib_1.__exportStar(require("./types/metricQuery"), exports);
 tslib_1.__exportStar(require("./types/metricsExplorer"), exports);
 tslib_1.__exportStar(require("./types/notifications"), exports);
@@ -121,6 +124,7 @@ tslib_1.__exportStar(require("./visualizations/TableDataModel"), exports);
 tslib_1.__exportStar(require("./visualizations/types"), exports);
 tslib_1.__exportStar(require("./visualizations/types/IResultsRunner"), exports);
 tslib_1.__exportStar(require("./types/spotlightTableConfig"), exports);
+tslib_1.__exportStar(require("./utils/loadLightdashProjectConfig"), exports);
 const validateEmail = (email) => {
     if (/\s/.test(email)) {
         return false;

package/dist/schemas/json/lightdash-dbt-2.0.json

@@ -186,6 +186,23 @@
                                                     "field",
                                                     "interval"
                                                 ]
+                                            },
+                                            "spotlight": {
+                                                "type": "object",
+                                                "description": "Set the visibility of a metric in Spotlight",
+                                                "properties": {
+                                                    "visibility": {
+                                                        "type": "string",
+                                                        "enum": ["show", "hide"]
+                                                    }
+                                                },
+                                                "anyOf": [
+                                                    {
+                                                        "required": [
+                                                            "visibility"
+                                                        ]
+                                                    }
+                                                ]
                                             }
                                         },
                                         "required": ["type", "sql"]
@@ -212,6 +229,17 @@
                                     }
                                 },
                                 "required": ["field", "interval"]
+                            },
+                            "spotlight": {
+                                "type": "object",
+                                "description": "Set the visibility of all metrics in this model in Spotlight",
+                                "properties": {
+                                    "visibility": {
+                                        "type": "string",
+                                        "enum": ["show", "hide"]
+                                    }
+                                },
+                                "anyOf": [{ "required": ["visibility"] }]
                             }
                         }
                     },
@@ -354,6 +382,26 @@
                                                                 "field",
                                                                 "interval"
                                                             ]
+                                                        },
+                                                        "spotlight": {
+                                                            "type": "object",
+                                                            "description": "Set the visibility of a metric in Spotlight",
+                                                            "properties": {
+                                                                "visibility": {
+                                                                    "type": "string",
+                                                                    "enum": [
+                                                                        "show",
+                                                                        "hide"
+                                                                    ]
+                                                                }
+                                                            },
+                                                            "anyOf": [
+                                                                {
+                                                                    "required": [
+                                                                        "visibility"
+                                                                    ]
+                                                                }
+                                                            ]
                                                         }
                                                     },
                                                     "required": ["type"]
@@ -626,6 +674,17 @@
                                     }
                                 },
                                 "required": ["field", "interval"]
+                            },
+                            "spotlight": {
+                                "type": "object",
+                                "description": "Set the visibility of a metric in Spotlight",
+                                "properties": {
+                                    "visibility": {
+                                        "type": "string",
+                                        "enum": ["show", "hide"]
+                                    }
+                                },
+                                "anyOf": [{ "required": ["visibility"] }]
                             }
                         }
                     }

package/dist/schemas/json/lightdash-project-config-1.0.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://schemas.lightdash.com/lightdash/config.json",
+    "type": ["object", "null"],
+    "properties": {
+        "spotlight": {
+            "type": ["object", "null"],
+            "properties": {
+                "default_visibility": {
+                    "type": "string",
+                    "enum": ["show", "hide"],
+                    "default": "show"
+                }
+            }
+        }
+    }
+}

package/dist/types/dbt.d.ts

@@ -3,6 +3,7 @@ import { type ColumnInfo, type CompiledModelNode, type ParsedMetric } from './db
 import { type CompactOrAlias, type DimensionType, type FieldUrl, type Format, type Metric, type MetricType, type Source } from './field';
 import { type OrderFieldsByStrategy } from './table';
 import { type DefaultTimeDimension, type TimeFrames } from './timeFrames';
+import { type LightdashProjectConfig } from './lightdashProjectConfig';
 export declare enum SupportedDbtAdapter {
     BIGQUERY = "bigquery",
     DATABRICKS = "databricks",
@@ -64,6 +65,9 @@ type DbtModelLightdashConfig = {
         field: string;
         interval: TimeFrames;
     };
+    spotlight?: {
+        visibility?: NonNullable<LightdashProjectConfig['spotlight']>['default_visibility'];
+    };
 };
 export type DbtModelGroup = {
     label: string;
@@ -126,6 +130,9 @@ export type DbtColumnLightdashMetric = {
     }[];
     percentile?: number;
     default_time_dimension?: DefaultTimeDimension;
+    spotlight?: {
+        visibility?: NonNullable<LightdashProjectConfig['spotlight']>['default_visibility'];
+    };
 } & DbtLightdashFieldTags;
 export type DbtModelLightdashMetric = DbtColumnLightdashMetric & Required<Pick<DbtColumnLightdashMetric, 'sql'>>;
 export declare const normaliseModelDatabase: (model: DbtRawModelNode, targetWarehouse: SupportedDbtAdapter) => DbtModelNode;
@@ -239,15 +246,17 @@ type ConvertModelMetricArgs = {
     tableLabel: string;
     dimensionReference?: string;
     requiredAttributes?: Record<string, string | string[]>;
+    spotlightConfig?: LightdashProjectConfig['spotlight'];
 };
-export declare const convertModelMetric: ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, }: ConvertModelMetricArgs) => Metric;
+export declare const convertModelMetric: ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, }: ConvertModelMetricArgs) => Metric;
 type ConvertColumnMetricArgs = Omit<ConvertModelMetricArgs, 'metric'> & {
     metric: DbtColumnLightdashMetric;
     dimensionName?: string;
     dimensionSql: string;
     requiredAttributes?: Record<string, string | string[]>;
+    modelCategories?: string[];
 };
-export declare const convertColumnMetric: ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, }: ConvertColumnMetricArgs) => Metric;
+export declare const convertColumnMetric: ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, }: ConvertColumnMetricArgs) => Metric;
 export declare enum DbtManifestVersion {
     V7 = "v7",
     V8 = "v8",

package/dist/types/dbt.js

@@ -134,8 +134,9 @@ const isDbtRpcRunSqlResults = (results) => 'results' in results &&
         'rows' in result.table &&
         Array.isArray(result.table.rows));
 exports.isDbtRpcRunSqlResults = isDbtRpcRunSqlResults;
-const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, }) => {
+const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, }) => {
     const groups = (0, exports.convertToGroups)(metric.groups, metric.group_label);
+    const spotlightVisibility = metric.spotlight?.visibility ?? spotlightConfig?.default_visibility;
     return {
         fieldType: field_1.FieldType.METRIC,
         name,
@@ -173,10 +174,17 @@ const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimen
                 },
             }
             : null),
+        ...(spotlightVisibility !== undefined
+            ? {
+                spotlight: {
+                    visibility: spotlightVisibility,
+                },
+            }
+            : {}),
     };
 };
 exports.convertModelMetric = convertModelMetric;
-const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, }) => (0, exports.convertModelMetric)({
+const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, }) => (0, exports.convertModelMetric)({
     modelName,
     name,
     metric: {
@@ -201,6 +209,7 @@ const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, met
             },
         }
         : null),
+    spotlightConfig,
 });
 exports.convertColumnMetric = convertColumnMetric;
 var DbtManifestVersion;

package/dist/types/explore.d.ts

@@ -1,5 +1,6 @@
 import { type DbtModelJoinType, type LineageGraph, type SupportedDbtAdapter } from './dbt';
 import { type CompiledDimension, type CompiledMetric, type Dimension, type Metric, type Source } from './field';
+import { type LightdashProjectConfig } from './lightdashProjectConfig';
 import { type TableBase } from './table';
 export type ExploreJoin = {
     table: string;
@@ -43,6 +44,9 @@ export type Explore = {
     ymlPath?: string;
     sqlPath?: string;
     type?: ExploreType;
+    spotlight?: {
+        visibility: Required<NonNullable<LightdashProjectConfig['spotlight']>>['default_visibility'];
+    };
 };
 export declare enum InlineErrorType {
     METADATA_PARSE_ERROR = "METADATA_PARSE_ERROR",

package/dist/types/field.d.ts

@@ -1,4 +1,4 @@
-import type { AdditionalMetric, currencies, DefaultTimeDimension } from '..';
+import type { AdditionalMetric, currencies, DefaultTimeDimension, LightdashProjectConfig } from '..';
 import { type MetricFilterRule } from './filter';
 import { type TimeFrames } from './timeFrames';
 export declare enum Compact {
@@ -240,6 +240,9 @@ export interface Metric extends Field {
     dimensionReference?: string;
     requiredAttributes?: Record<string, string | string[]>;
     defaultTimeDimension?: DefaultTimeDimension;
+    spotlight?: {
+        visibility: Required<NonNullable<LightdashProjectConfig['spotlight']>>['default_visibility'];
+    };
 }
 export declare const isFilterableDimension: (dimension: Dimension) => dimension is FilterableDimension;
 export type FilterableField = TableCalculation | Metric | FilterableDimension | CustomSqlDimension;

package/dist/types/lightdashProjectConfig.d.ts

@@ -0,0 +1,8 @@
+type SpotlightConfig = {
+    default_visibility: 'show' | 'hide';
+};
+export type LightdashProjectConfig = {
+    spotlight: SpotlightConfig;
+};
+export declare const DEFAULT_SPOTLIGHT_CONFIG: Required<SpotlightConfig>;
+export {};

package/dist/types/lightdashProjectConfig.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SPOTLIGHT_CONFIG = void 0;
+exports.DEFAULT_SPOTLIGHT_CONFIG = {
+    default_visibility: 'show',
+};

package/dist/utils/item.d.ts

@@ -51,5 +51,8 @@ export declare const replaceDimensionInExplore: (explore: Explore, dimension: Co
     ymlPath?: string | undefined;
     sqlPath?: string | undefined;
     type?: import("../types/explore").ExploreType | undefined;
+    spotlight?: {
+        visibility: "show" | "hide";
+    } | undefined;
 };
 export declare const canApplyFormattingToCustomMetric: (item: Dimension, customMetricType: MetricType) => boolean;

package/dist/utils/loadLightdashProjectConfig.d.ts

@@ -0,0 +1,2 @@
+import { type LightdashProjectConfig } from '../types/lightdashProjectConfig';
+export declare const loadLightdashProjectConfig: (yamlFileContents: string) => Promise<LightdashProjectConfig>;

package/dist/utils/loadLightdashProjectConfig.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadLightdashProjectConfig = void 0;
+const tslib_1 = require("tslib");
+const ajv_1 = tslib_1.__importDefault(require("ajv"));
+const yaml = tslib_1.__importStar(require("js-yaml"));
+const better_ajv_errors_1 = tslib_1.__importDefault(require("better-ajv-errors"));
+const lightdashProjectConfig_1 = require("../types/lightdashProjectConfig");
+const lightdash_project_config_1_0_json_1 = tslib_1.__importDefault(require("../schemas/json/lightdash-project-config-1.0.json"));
+const errors_1 = require("../types/errors");
+const loadLightdashProjectConfig = async (yamlFileContents) => {
+    if (yamlFileContents.trim() === '') {
+        return {
+            spotlight: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG,
+        };
+    }
+    const configFile = yaml.load(yamlFileContents);
+    const ajv = new ajv_1.default({ coerceTypes: true });
+    const validate = ajv.compile(lightdash_project_config_1_0_json_1.default);
+    if (!validate(configFile)) {
+        const errors = (0, better_ajv_errors_1.default)(lightdash_project_config_1_0_json_1.default, configFile, validate.errors || [], { indent: 2 });
+        throw new errors_1.ParseError(`Invalid lightdash.config.yml with errors:\n${errors}`);
+    }
+    return configFile;
+};
+exports.loadLightdashProjectConfig = loadLightdashProjectConfig;

package/dist/utils/virtualView.js

@@ -42,6 +42,7 @@ const createVirtualView = (virtualViewName, sql, columns, warehouseClient, label
         joinedTables: [],
         tables: { [virtualViewName]: compiledTable },
         targetDatabase: warehouseClient.getAdapterType(),
+        meta: {},
     });
     const virtualView = {
         ...explore,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/common",
-  "version": "0.1462.1",
+  "version": "0.1463.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -8,6 +8,7 @@
   ],
   "license": "MIT",
   "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
     "@types/pegjs": "^0.10.3",
     "@types/sanitize-html": "^2.11.0",
     "@types/uuid": "^10.0.0",
@@ -18,9 +19,11 @@
     "@types/lodash": "^4.14.202",
     "ajv": "^8.3.0",
     "ajv-formats": "^2.1.0",
+    "better-ajv-errors": "^1.2.0",
     "cronstrue": "^2.23.0",
     "dayjs": "^1.11.9",
     "dependency-graph": "^0.11.0",
+    "js-yaml": "^4.1.0",
     "liquidjs": "^10.0.0",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",