@lightdash/common 0.1464.2 → 0.1465.0

package/dist/compiler/exploreCompiler.d.ts

@@ -1,9 +1,9 @@
 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';
+import { type WarehouseClient } from '../types/warehouse';
 export declare const lightdashVariablePattern: RegExp;
 type Reference = {
     refTable: string;

package/dist/compiler/exploreCompiler.js

@@ -7,6 +7,7 @@ const timeFrames_1 = require("../types/timeFrames");
 const timeFrames_2 = require("../utils/timeFrames");
 const warehouse_1 = require("../utils/warehouse");
 const filtersCompiler_1 = require("./filtersCompiler");
+const lightdashProjectConfig_1 = require("./lightdashProjectConfig");
 // exclude lightdash prefix from variable pattern
 exports.lightdashVariablePattern = /\$\{((?!(lightdash|ld)\.)[a-zA-Z0-9_.]+)\}/g;
 const getParsedReference = (ref, currentTable) => {
@@ -119,14 +120,8 @@ class ExploreCompiler {
         }), {});
         const compiledJoins = joinedTables.map((j) => this.compileJoin(j, includedTables));
         const spotlightVisibility = meta.spotlight?.visibility ?? spotlightConfig?.default_visibility;
+        const spotlightCategories = (0, lightdashProjectConfig_1.getCategoriesFromResource)('explore', name, spotlightConfig, meta.spotlight?.categories);
         return {
-            ...(spotlightVisibility !== undefined
-                ? {
-                    spotlight: {
-                        visibility: spotlightVisibility,
-                    },
-                }
-                : {}),
             name,
             label,
             tags,
@@ -138,6 +133,7 @@ class ExploreCompiler {
             warehouse,
             ymlPath,
             sqlPath,
+            ...(0, lightdashProjectConfig_1.getSpotlightConfigurationForResource)(spotlightVisibility, spotlightCategories),
         };
     }
     compileTable(table, tables) {

package/dist/compiler/exploreCompiler.mock.js

@@ -81,6 +81,7 @@ exports.exploreBase = {
     tags: [],
     spotlight: {
         visibility: 'show',
+        categories: [],
     },
     baseTable: 'a',
     joinedTables: [],
@@ -1423,6 +1424,7 @@ exports.exploreWithMetricNumberCompiled = {
     groupLabel: exports.exploreWithMetricNumber.groupLabel,
     spotlight: {
         visibility: 'show',
+        categories: [],
     },
     joinedTables: [],
     tables: {

package/dist/compiler/lightdashProjectConfig.d.ts

@@ -0,0 +1,19 @@
+import type { Explore } from '../types/explore';
+import type { Metric } from '../types/field';
+import type { LightdashProjectConfig } from '../types/lightdashProjectConfig';
+/**
+ * Get the spotlight configuration for a resource
+ * @param visibility - The visibility of the resource
+ * @param categories - The categories of the resource
+ * @returns The spotlight configuration for the resource
+ */
+export declare const getSpotlightConfigurationForResource: (visibility?: LightdashProjectConfig['spotlight']['default_visibility'], categories?: string[]) => Pick<Explore, 'spotlight'> | Pick<Metric, 'spotlight'>;
+/**
+ * Get the categories from the resource and validate them against the project config
+ * @param resourceType - The type of the resource
+ * @param resourceName - The name of the resource
+ * @param spotlightConfig - The spotlight config
+ * @param resourceCategories - The categories from the resource
+ * @returns The categories from the resource
+ */
+export declare const getCategoriesFromResource: (resourceType: 'metric' | 'explore', resourceName: string, spotlightConfig: LightdashProjectConfig['spotlight'] | undefined, resourceCategories?: string[] | undefined) => string[];

package/dist/compiler/lightdashProjectConfig.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCategoriesFromResource = exports.getSpotlightConfigurationForResource = void 0;
+const errors_1 = require("../types/errors");
+/**
+ * Get the spotlight configuration for a resource
+ * @param visibility - The visibility of the resource
+ * @param categories - The categories of the resource
+ * @returns The spotlight configuration for the resource
+ */
+const getSpotlightConfigurationForResource = (visibility, categories) => {
+    if (visibility === undefined) {
+        return {};
+    }
+    return {
+        spotlight: {
+            visibility,
+            categories,
+        },
+    };
+};
+exports.getSpotlightConfigurationForResource = getSpotlightConfigurationForResource;
+/**
+ * Get the categories from the resource and validate them against the project config
+ * @param resourceType - The type of the resource
+ * @param resourceName - The name of the resource
+ * @param spotlightConfig - The spotlight config
+ * @param resourceCategories - The categories from the resource
+ * @returns The categories from the resource
+ */
+const getCategoriesFromResource = (resourceType, resourceName, spotlightConfig, resourceCategories = []) => {
+    // Get all valid category references from the global spotlight config
+    const categoriesDefinedInProjectConfig = Object.keys(spotlightConfig?.categories || {}) || [];
+    // Check if any metric categories aren't defined in the global config
+    const invalidCategories = resourceCategories.filter((category) => !categoriesDefinedInProjectConfig.includes(category));
+    if (invalidCategories.length > 0) {
+        throw new errors_1.ParseError(`Invalid spotlight categories found in ${resourceType} '${resourceName}': ${invalidCategories.join(', ')}. Categories must be defined in project config.`);
+    }
+    return resourceCategories;
+};
+exports.getCategoriesFromResource = getCategoriesFromResource;

package/dist/compiler/translator.js

@@ -11,6 +11,7 @@ const table_1 = require("../types/table");
 const assertUnreachable_1 = tslib_1.__importDefault(require("../utils/assertUnreachable"));
 const timeFrames_1 = require("../utils/timeFrames");
 const exploreCompiler_1 = require("./exploreCompiler");
+const lightdashProjectConfig_1 = require("./lightdashProjectConfig");
 const convertTimezone = (timestampSql, default_source_tz, target_tz, adapterType) => {
     // todo: implement default_source_tz
     // todo: implement target_tz
@@ -118,7 +119,7 @@ const generateTableLineage = (model, depGraph) => {
             .map((d) => depGraph.getNodeData(d)),
     }), {});
 };
-const convertDbtMetricToLightdashMetric = (metric, tableName, tableLabel, spotlightConfig) => {
+const convertDbtMetricToLightdashMetric = (metric, tableName, tableLabel, spotlightConfig, modelCategories) => {
     let sql;
     let type;
     if (metric.calculation_method === 'derived') {
@@ -161,7 +162,8 @@ const convertDbtMetricToLightdashMetric = (metric, tableName, tableLabel, spotli
         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;
+    const spotlightVisibility = spotlightConfig.default_visibility;
+    const spotlightCategories = (0, lightdashProjectConfig_1.getCategoriesFromResource)('metric', metric.name, spotlightConfig, Array.from(new Set([...(modelCategories || [])])));
     return {
         fieldType: field_1.FieldType.METRIC,
         type,
@@ -189,13 +191,7 @@ const convertDbtMetricToLightdashMetric = (metric, tableName, tableLabel, spotli
                     : [metric.meta.tags],
             }
             : {}),
-        ...(spotlightVisibility !== undefined
-            ? {
-                spotlight: {
-                    visibility: spotlightVisibility,
-                },
-            }
-            : {}),
+        ...(0, lightdashProjectConfig_1.getSpotlightConfigurationForResource)(spotlightVisibility, spotlightCategories),
     };
 };
 const convertTable = (adapterType, model, dbtMetrics, spotlightConfig, startOfWeek) => {
@@ -278,6 +274,7 @@ const convertTable = (adapterType, model, dbtMetrics, spotlightConfig, startOfWe
                     default_visibility: model.meta.spotlight?.visibility ??
                         spotlightConfig.default_visibility,
                 },
+                modelCategories: model.meta.spotlight?.categories,
             }),
         ]));
         return [
@@ -299,13 +296,14 @@ const convertTable = (adapterType, model, dbtMetrics, spotlightConfig, startOfWe
             spotlightConfig: {
                 ...spotlightConfig,
                 default_visibility: model.meta.spotlight?.visibility ??
-                    spotlightConfig?.default_visibility,
+                    spotlightConfig.default_visibility,
             },
+            modelCategories: model.meta.spotlight?.categories,
         }),
     ]));
     const convertedDbtMetrics = Object.fromEntries(dbtMetrics.map((metric) => [
         metric.name,
-        convertDbtMetricToLightdashMetric(metric, model.name, tableLabel, spotlightConfig),
+        convertDbtMetricToLightdashMetric(metric, model.name, tableLabel, spotlightConfig, model.meta.spotlight?.categories),
     ]));
     const allMetrics = Object.values({
         ...convertedDbtMetrics,

package/dist/compiler/translator.mock.js

@@ -319,6 +319,7 @@ exports.LIGHTDASH_TABLE_WITH_GROUP_BLOCK = {
             type: field_1.MetricType.COUNT_DISTINCT,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
     },
@@ -399,6 +400,7 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             index: 0,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
         dbt_metric_2: {
@@ -423,6 +425,7 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             index: 1,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
         dbt_metric_3: {
@@ -447,6 +450,7 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             index: 2,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
         dbt_metric_4: {
@@ -471,6 +475,7 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             index: 3,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
         dbt_metric_5: {
@@ -495,6 +500,7 @@ exports.LIGHTDASH_TABLE_WITH_DBT_METRICS = {
             index: 4,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
     },
@@ -524,6 +530,7 @@ exports.LIGHTDASH_TABLE_WITH_DBT_V9_METRICS = {
             index: 0,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
     },
@@ -649,6 +656,7 @@ exports.LIGHTDASH_TABLE_WITH_METRICS = {
             requiredAttributes: undefined,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
         total_num_participating_athletes: {
@@ -675,6 +683,7 @@ exports.LIGHTDASH_TABLE_WITH_METRICS = {
             requiredAttributes: undefined,
             spotlight: {
                 visibility: 'show',
+                categories: [],
             },
         },
     },

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

@@ -190,11 +190,18 @@
                                             },
                                             "spotlight": {
                                                 "type": "object",
-                                                "description": "Set the visibility of a metric in Spotlight",
+                                                "description": "Set the visibility and/or categories of a metric in Spotlight",
                                                 "properties": {
                                                     "visibility": {
                                                         "type": "string",
                                                         "enum": ["show", "hide"]
+                                                    },
+                                                    "categories": {
+                                                        "type": "array",
+                                                        "items": {
+                                                            "type": "string"
+                                                        },
+                                                        "description": "An array of categories for the metric in Spotlight"
                                                     }
                                                 },
                                                 "anyOf": [
@@ -202,6 +209,11 @@
                                                         "required": [
                                                             "visibility"
                                                         ]
+                                                    },
+                                                    {
+                                                        "required": [
+                                                            "categories"
+                                                        ]
                                                     }
                                                 ]
                                             }
@@ -233,14 +245,24 @@
                             },
                             "spotlight": {
                                 "type": "object",
-                                "description": "Set the visibility of all metrics in this model in Spotlight",
+                                "description": "Set the visibility and/or categories of a metric in Spotlight",
                                 "properties": {
                                     "visibility": {
                                         "type": "string",
                                         "enum": ["show", "hide"]
+                                    },
+                                    "categories": {
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "description": "An optional array of categories for all metrics in this model in Spotlight"
                                     }
                                 },
-                                "anyOf": [{ "required": ["visibility"] }]
+                                "anyOf": [
+                                    { "required": ["visibility"] },
+                                    { "required": ["categories"] }
+                                ]
                             }
                         }
                     },
@@ -387,7 +409,7 @@
                                                         },
                                                         "spotlight": {
                                                             "type": "object",
-                                                            "description": "Set the visibility of a metric in Spotlight",
+                                                            "description": "Set the visibility and/or categories of a metric in Spotlight",
                                                             "properties": {
                                                                 "visibility": {
                                                                     "type": "string",
@@ -395,6 +417,13 @@
                                                                         "show",
                                                                         "hide"
                                                                     ]
+                                                                },
+                                                                "categories": {
+                                                                    "type": "array",
+                                                                    "items": {
+                                                                        "type": "string"
+                                                                    },
+                                                                    "description": "An array of categories for the metric in Spotlight"
                                                                 }
                                                             },
                                                             "anyOf": [
@@ -402,6 +431,11 @@
                                                                     "required": [
                                                                         "visibility"
                                                                     ]
+                                                                },
+                                                                {
+                                                                    "required": [
+                                                                        "categories"
+                                                                    ]
                                                                 }
                                                             ]
                                                         }
@@ -681,14 +715,24 @@
                             },
                             "spotlight": {
                                 "type": "object",
-                                "description": "Set the visibility of a metric in Spotlight",
+                                "description": "Set the visibility and/or categories of a metric in Spotlight",
                                 "properties": {
                                     "visibility": {
                                         "type": "string",
                                         "enum": ["show", "hide"]
+                                    },
+                                    "categories": {
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "description": "An array of categories for the metric in Spotlight"
                                     }
                                 },
-                                "anyOf": [{ "required": ["visibility"] }]
+                                "anyOf": [
+                                    { "required": ["visibility"] },
+                                    { "required": ["categories"] }
+                                ]
                             }
                         }
                     }

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

@@ -9,7 +9,39 @@
                 "default_visibility": {
                     "type": "string",
                     "enum": ["show", "hide"],
-                    "default": "show"
+                    "default": "show",
+                    "description": "The visibility of Spotlight metrics by default - if not provided, it will be set to 'show'"
+                },
+                "categories": {
+                    "type": "object",
+                    "description": "Define the categories that can be used in Spotlight on your model yml files",
+                    "patternProperties": {
+                        "^[a-zA-Z0-9_-]+$": {
+                            "type": "object",
+                            "properties": {
+                                "label": {
+                                    "description": "The label of the category as it will be displayed in Spotlight",
+                                    "type": "string"
+                                },
+                                "color": {
+                                    "description": "The color of the category, if not provided, it will be set to gray",
+                                    "type": "string",
+                                    "enum": [
+                                        "gray",
+                                        "violet",
+                                        "red",
+                                        "orange",
+                                        "green",
+                                        "blue",
+                                        "indigo",
+                                        "pink",
+                                        "yellow"
+                                    ]
+                                }
+                            },
+                            "required": ["label"]
+                        }
+                    }
                 }
             }
         }

package/dist/types/catalog.d.ts

@@ -41,7 +41,7 @@ export type CatalogField = Pick<Field, 'name' | 'label' | 'fieldType' | 'tableLa
     tableName: string;
     tableGroupLabel?: string;
     tags?: string[];
-    categories: Pick<Tag, 'name' | 'color' | 'tagUuid'>[];
+    categories: Pick<Tag, 'name' | 'color' | 'tagUuid' | 'yamlReference'>[];
     chartUsage: number | undefined;
     icon: CatalogItemIcon | null;
 };
@@ -51,7 +51,7 @@ export type CatalogTable = Pick<TableBase, 'name' | 'label' | 'groupLabel' | 'de
     type: CatalogType.Table;
     groupLabel?: string;
     tags?: string[];
-    categories: Pick<Tag, 'name' | 'color' | 'tagUuid'>[];
+    categories: Pick<Tag, 'name' | 'color' | 'tagUuid' | 'yamlReference'>[];
     joinedTables?: CompiledExploreJoin[];
     chartUsage: number | undefined;
     icon: CatalogItemIcon | null;
@@ -129,6 +129,7 @@ export type CatalogItemWithTagUuids = CatalogItemSummary & {
         tagUuid: string;
         createdByUserUuid: string | null;
         createdAt: Date;
+        taggedViaYaml: boolean;
     }[];
 };
 export type CatalogItemsWithIcons = CatalogItemSummary & Pick<CatalogItem, 'icon'>;

package/dist/types/dbt.d.ts

@@ -68,6 +68,7 @@ type DbtModelLightdashConfig = {
     };
     spotlight?: {
         visibility?: NonNullable<LightdashProjectConfig['spotlight']>['default_visibility'];
+        categories?: string[];
     };
 };
 export type DbtModelGroup = {
@@ -133,6 +134,7 @@ export type DbtColumnLightdashMetric = {
     default_time_dimension?: DefaultTimeDimension;
     spotlight?: {
         visibility?: NonNullable<LightdashProjectConfig['spotlight']>['default_visibility'];
+        categories?: string[];
     };
 } & DbtLightdashFieldTags;
 export type DbtModelLightdashMetric = DbtColumnLightdashMetric & Required<Pick<DbtColumnLightdashMetric, 'sql'>>;
@@ -248,8 +250,9 @@ type ConvertModelMetricArgs = {
     dimensionReference?: string;
     requiredAttributes?: Record<string, string | string[]>;
     spotlightConfig?: LightdashProjectConfig['spotlight'];
+    modelCategories?: string[];
 };
-export declare const convertModelMetric: ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, }: ConvertModelMetricArgs) => Metric;
+export declare const convertModelMetric: ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, modelCategories, }: ConvertModelMetricArgs) => Metric;
 type ConvertColumnMetricArgs = Omit<ConvertModelMetricArgs, 'metric'> & {
     metric: DbtColumnLightdashMetric;
     dimensionName?: string;
@@ -257,7 +260,7 @@ type ConvertColumnMetricArgs = Omit<ConvertModelMetricArgs, 'metric'> & {
     requiredAttributes?: Record<string, string | string[]>;
     modelCategories?: string[];
 };
-export declare const convertColumnMetric: ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, }: ConvertColumnMetricArgs) => Metric;
+export declare const convertColumnMetric: ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, modelCategories, }: ConvertColumnMetricArgs) => Metric;
 export declare enum DbtManifestVersion {
     V7 = "v7",
     V8 = "v8",

package/dist/types/dbt.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCompiledModels = exports.getModelsFromManifest = exports.DbtExposureType = exports.getLatestSupportedDbtManifestVersion = exports.getDbtManifestVersion = exports.DbtManifestVersion = exports.convertColumnMetric = exports.convertModelMetric = exports.isDbtRpcRunSqlResults = exports.convertToGroups = exports.isDbtRpcCompileResults = exports.isDbtRpcManifestResults = exports.isSupportedDbtAdapterType = exports.isSupportedDbtAdapter = exports.isV9MetricRef = exports.isDbtPackages = exports.isDbtRpcDocsGenerateResults = exports.buildModelGraph = exports.patchPathParts = exports.normaliseModelDatabase = exports.SupportedDbtAdapter = void 0;
 const tslib_1 = require("tslib");
 const dependency_graph_1 = require("dependency-graph");
+const lightdashProjectConfig_1 = require("../compiler/lightdashProjectConfig");
 const assertUnreachable_1 = tslib_1.__importDefault(require("../utils/assertUnreachable"));
 const item_1 = require("../utils/item");
 const errors_1 = require("./errors");
@@ -136,9 +137,11 @@ 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, spotlightConfig, }) => {
+const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, modelCategories = [], }) => {
     const groups = (0, exports.convertToGroups)(metric.groups, metric.group_label);
     const spotlightVisibility = metric.spotlight?.visibility ?? spotlightConfig?.default_visibility;
+    const metricCategories = Array.from(new Set([...modelCategories, ...(metric.spotlight?.categories || [])]));
+    const spotlightCategories = (0, lightdashProjectConfig_1.getCategoriesFromResource)('metric', name, spotlightConfig, metricCategories);
     return {
         fieldType: field_1.FieldType.METRIC,
         name,
@@ -176,17 +179,11 @@ const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimen
                 },
             }
             : null),
-        ...(spotlightVisibility !== undefined
-            ? {
-                spotlight: {
-                    visibility: spotlightVisibility,
-                },
-            }
-            : {}),
+        ...(0, lightdashProjectConfig_1.getSpotlightConfigurationForResource)(spotlightVisibility, spotlightCategories),
     };
 };
 exports.convertModelMetric = convertModelMetric;
-const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, }) => (0, exports.convertModelMetric)({
+const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, modelCategories = [], }) => (0, exports.convertModelMetric)({
     modelName,
     name,
     metric: {
@@ -212,6 +209,7 @@ const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, met
         }
         : null),
     spotlightConfig,
+    modelCategories,
 });
 exports.convertColumnMetric = convertColumnMetric;
 var DbtManifestVersion;

package/dist/types/explore.d.ts

@@ -45,7 +45,8 @@ export type Explore = {
     sqlPath?: string;
     type?: ExploreType;
     spotlight?: {
-        visibility: Required<NonNullable<LightdashProjectConfig['spotlight']>>['default_visibility'];
+        visibility: LightdashProjectConfig['spotlight']['default_visibility'];
+        categories?: string[];
     };
 };
 export declare enum InlineErrorType {

package/dist/types/field.d.ts

@@ -243,7 +243,8 @@ export interface Metric extends Field {
     requiredAttributes?: Record<string, string | string[]>;
     defaultTimeDimension?: DefaultTimeDimension;
     spotlight?: {
-        visibility: Required<NonNullable<LightdashProjectConfig['spotlight']>>['default_visibility'];
+        visibility: LightdashProjectConfig['spotlight']['default_visibility'];
+        categories?: string[];
     };
 }
 export declare const isFilterableDimension: (dimension: Dimension) => dimension is FilterableDimension;

package/dist/types/lightdashProjectConfig.d.ts

@@ -1,8 +1,15 @@
+type SpotlightCategory = {
+    label: string;
+    color?: string;
+};
 type SpotlightConfig = {
     default_visibility: 'show' | 'hide';
+    categories?: {
+        [yaml_reference: string]: SpotlightCategory;
+    };
 };
 export type LightdashProjectConfig = {
     spotlight: SpotlightConfig;
 };
-export declare const DEFAULT_SPOTLIGHT_CONFIG: Required<SpotlightConfig>;
+export declare const DEFAULT_SPOTLIGHT_CONFIG: SpotlightConfig;
 export {};

package/dist/types/tags.d.ts

@@ -5,6 +5,7 @@ export type Tag = {
     name: string;
     color: string;
     createdAt: Date;
+    yamlReference: string | null;
     createdBy: Pick<LightdashUser, 'userUuid' | 'firstName' | 'lastName'> | null;
 };
 export type ApiGetTagsResponse = {
@@ -17,3 +18,7 @@ export type ApiCreateTagResponse = {
         tagUuid: string;
     };
 };
+export type ApiReplaceYamlTagsResponse = {
+    status: 'ok';
+    results: undefined;
+};

package/dist/utils/item.d.ts

@@ -53,6 +53,7 @@ export declare const replaceDimensionInExplore: (explore: Explore, dimension: Co
     type?: import("../types/explore").ExploreType | undefined;
     spotlight?: {
         visibility: "show" | "hide";
+        categories?: string[] | undefined;
     } | undefined;
 };
 export declare const canApplyFormattingToCustomMetric: (item: Dimension, customMetricType: MetricType) => boolean;

package/package.json

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