@lightdash/common 0.1462.2 → 0.1464.0

package/dist/compiler/exploreCompiler.d.ts

@@ -1,7 +1,8 @@
-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 LightdashProjectConfig } from '../types/lightdashProjectConfig';
 import { type DateGranularity } from '../types/timeFrames';
 export declare const lightdashVariablePattern: RegExp;
 type Reference = {
@@ -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/dbt/schemas/lightdashMetadata.json

@@ -32,7 +32,7 @@
         },
         "Format": {
             "type": "string",
-            "enum": ["km", "mi", "usd", "gbp", "eur", "jpy", "id", "percent"]
+            "enum": ["km", "mi", "usd", "gbp", "eur", "jpy", "dkk", "percent"]
         },
         "Urls": {
             "type": "array",

package/dist/dbt/validation.d.ts

@@ -1,11 +1,12 @@
 import { type ValidateFunction } from 'ajv';
 import { type AnyValidateFunction } from 'ajv/dist/types';
+import { type AnyType } from '../types/any';
 import { type DbtManifestVersion, type DbtMetric, type DbtRawModelNode } from '../types/dbt';
 export declare class ManifestValidator {
     private readonly lightdashSchemaId;
     private readonly dbtSchemaId;
     constructor(manifestVersion: DbtManifestVersion);
-    static isValid: (validator: ValidateFunction<any>, data: any) => [true, undefined] | [false, string];
+    static isValid: (validator: ValidateFunction<AnyType>, data: AnyType) => [true, undefined] | [false, string];
     static formatAjvErrors: (validator: AnyValidateFunction) => string;
     static getValidator: <T>(schemaRef: string) => AnyValidateFunction<T>;
     isModelValid: (model: DbtRawModelNode) => [true, undefined] | [false, string];

package/dist/index.d.ts

@@ -36,6 +36,8 @@ import { type TableBase } from './types/table';
 import { type LightdashUser, type LoginOptions, type UserAllowedOrganization } from './types/user';
 import { type UserWarehouseCredentials } from './types/userWarehouseCredentials';
 import { type ValidationResponse } from './types/validation';
+import { type AnyType } from './types/any';
+import { type ApiGetSpotlightTableConfig } from './types/api/spotlight';
 import { type ApiCatalogAnalyticsResults, type ApiCatalogMetadataResults, type ApiGetMetricsTree, type ApiMetricsCatalog } from './types/catalog';
 import { type ApiChartAsCodeListResponse, type ApiChartAsCodeUpsertResponse, type ApiDashboardAsCodeListResponse } from './types/coder';
 import { type ApiChartContentResponse, type ApiContentResponse } from './types/content';
@@ -45,7 +47,6 @@ import { type ApiPromotionChangesResponse } from './types/promotion';
 import { type ApiSemanticLayerClientInfo, type ApiSemanticViewerChartCreate, type ApiSemanticViewerChartGet, type ApiSemanticViewerChartUpdate } from './types/semanticLayer';
 import { type ApiCreateSqlChart, type ApiCreateVirtualView, type ApiGithubDbtWritePreview, type ApiSqlChart, type ApiSqlRunnerJobStatusResponse, type ApiUpdateSqlChart } from './types/sqlRunner';
 import { type ApiWarehouseTableFields } from './types/warehouse';
-import { type ApiGetSpotlightTableConfig } from './types/api/spotlight';
 export * from './authorization/index';
 export * from './authorization/types';
 export * from './compiler/exploreCompiler';
@@ -54,17 +55,19 @@ 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/any';
 export * from './types/api';
 export * from './types/api/comments';
 export * from './types/api/errors';
 export * from './types/api/notifications';
 export * from './types/api/share';
 export * from './types/api/sort';
+export * from './types/api/spotlight';
 export * from './types/api/success';
 export * from './types/api/uuid';
-export * from './types/api/spotlight';
 export * from './types/catalog';
 export * from './types/coder';
 export * from './types/comments';
@@ -88,6 +91,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';
@@ -112,6 +116,7 @@ export * from './types/share';
 export * from './types/slack';
 export * from './types/slackSettings';
 export * from './types/space';
+export * from './types/spotlightTableConfig';
 export * from './types/sqlRunner';
 export * from './types/SshKeyPair';
 export * from './types/table';
@@ -136,6 +141,7 @@ export * from './utils/filters';
 export * from './utils/formatting';
 export * from './utils/github';
 export * from './utils/item';
+export * from './utils/loadLightdashProjectConfig';
 export * from './utils/metricsExplorer';
 export * from './utils/projectMemberRole';
 export * from './utils/sanitizeHtml';
@@ -151,7 +157,6 @@ export * from './visualizations/PieChartDataModel';
 export * from './visualizations/TableDataModel';
 export * from './visualizations/types';
 export * from './visualizations/types/IResultsRunner';
-export * from './types/spotlightTableConfig';
 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;
@@ -226,7 +231,7 @@ export declare const SEED_GROUP: {
     groupUuid: string;
     name: string;
 };
-export type ArgumentsOf<F extends Function> = F extends (...args: infer A) => any ? A : never;
+export type ArgumentsOf<F extends Function> = F extends (...args: infer A) => AnyType ? A : never;
 export declare const getVisibleFields: (explore: Explore) => CompiledField[];
 export declare const findFieldByIdInExplore: (explore: Explore, id: FieldId) => Field | undefined;
 export declare const snakeCaseName: (text: string) => string;
@@ -549,8 +554,8 @@ export declare const getMetricsFromItemsMap: (itemsMap: ItemsMap, filter?: (valu
 export declare const getTableCalculationsFromItemsMap: (itemsMap?: ItemsMap) => Record<string, TableCalculation>;
 export declare function itemsInMetricQuery(metricQuery: MetricQuery | undefined): string[];
 export declare function formatRows(rows: {
-    [col: string]: any;
+    [col: string]: AnyType;
 }[], itemsMap: ItemsMap): ResultRow[];
-export declare const removeEmptyProperties: (object: Record<string, any>) => Record<string, any>;
-export declare const deepEqual: (object1: Record<string, any>, object2: Record<string, any>) => boolean;
+export declare const removeEmptyProperties: (object: Record<string, AnyType>) => Record<string, any>;
+export declare const deepEqual: (object1: Record<string, AnyType>, object2: Record<string, AnyType>) => boolean;
 export declare const getProjectDirectory: (dbtConnection?: DbtProjectConfig) => string | undefined;