@lightdash/common 0.1464.3 → 0.1466.0

package/LICENSE

@@ -1,6 +1,10 @@
-MIT License
+Copyright (c) 2021-present Telescope Technology Limited (trading as “Lightdash”)
 
-Copyright (c) 2021 Telescope Technologies Inc.
+Portions of this software are licensed as follows:
+
+* All content that resides under the "packages/backend/src/ee" directory of this repository, if that directory exists, is licensed under the license defined in "packages/backend/src/ee/LICENSE".
+* All third party components incorporated into the Lightdash Software are licensed under the original license provided by the owner of the applicable component.
+* Content outside of the above mentioned directories or restrictions above is available under the "MIT" license as defined below.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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: [],
             },
         },
     },