@lightdash/common 0.1462.2 → 0.1464.0

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,17 +22,20 @@ 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/any"), exports);
 tslib_1.__exportStar(require("./types/api"), exports);
 tslib_1.__exportStar(require("./types/api/comments"), exports);
 tslib_1.__exportStar(require("./types/api/errors"), exports);
 tslib_1.__exportStar(require("./types/api/notifications"), exports);
 tslib_1.__exportStar(require("./types/api/share"), exports);
 tslib_1.__exportStar(require("./types/api/sort"), exports);
+tslib_1.__exportStar(require("./types/api/spotlight"), exports);
 tslib_1.__exportStar(require("./types/api/success"), exports);
 tslib_1.__exportStar(require("./types/api/uuid"), exports);
-tslib_1.__exportStar(require("./types/api/spotlight"), exports);
 tslib_1.__exportStar(require("./types/catalog"), exports);
 tslib_1.__exportStar(require("./types/coder"), exports);
 tslib_1.__exportStar(require("./types/comments"), exports);
@@ -56,6 +59,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);
@@ -80,6 +84,7 @@ tslib_1.__exportStar(require("./types/share"), exports);
 tslib_1.__exportStar(require("./types/slack"), exports);
 tslib_1.__exportStar(require("./types/slackSettings"), exports);
 tslib_1.__exportStar(require("./types/space"), exports);
+tslib_1.__exportStar(require("./types/spotlightTableConfig"), exports);
 tslib_1.__exportStar(require("./types/sqlRunner"), exports);
 tslib_1.__exportStar(require("./types/SshKeyPair"), exports);
 tslib_1.__exportStar(require("./types/table"), exports);
@@ -105,6 +110,7 @@ tslib_1.__exportStar(require("./utils/filters"), exports);
 tslib_1.__exportStar(require("./utils/formatting"), exports);
 tslib_1.__exportStar(require("./utils/github"), exports);
 tslib_1.__exportStar(require("./utils/item"), exports);
+tslib_1.__exportStar(require("./utils/loadLightdashProjectConfig"), exports);
 tslib_1.__exportStar(require("./utils/metricsExplorer"), exports);
 tslib_1.__exportStar(require("./utils/projectMemberRole"), exports);
 tslib_1.__exportStar(require("./utils/sanitizeHtml"), exports);
@@ -120,7 +126,6 @@ tslib_1.__exportStar(require("./visualizations/PieChartDataModel"), exports);
 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);
 const validateEmail = (email) => {
     if (/\s/.test(email)) {
         return false;

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

@@ -146,6 +146,7 @@
                                                     "usd",
                                                     "gbp",
                                                     "jpy",
+                                                    "dkk",
                                                     "eur",
                                                     "percent",
                                                     "id"
@@ -186,6 +187,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 +230,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"] }]
                             }
                         }
                     },
@@ -313,6 +342,7 @@
                                                                 "mi",
                                                                 "usd",
                                                                 "jpy",
+                                                                "dkk",
                                                                 "gbp",
                                                                 "eur",
                                                                 "percent",
@@ -354,6 +384,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"]
@@ -399,6 +449,7 @@
                                                         "mi",
                                                         "usd",
                                                         "jpy",
+                                                        "dkk",
                                                         "gbp",
                                                         "eur",
                                                         "percent",
@@ -600,6 +651,7 @@
                                     "mi",
                                     "usd",
                                     "jpy",
+                                    "dkk",
                                     "gbp",
                                     "eur",
                                     "percent",
@@ -626,6 +678,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/any.d.ts

@@ -0,0 +1,7 @@
+/** This AnyType is an alias for any
+ * The goal is to make it easier to identify any type in the codebase
+ * without having to eslint-disable all the time
+ * These are only used on legacy `any` types, don't use it for new types.
+ * This is added on a separate file to avoid circular dependencies.
+ */
+export type AnyType = any;

package/dist/types/any.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/api/errors.d.ts

@@ -1,3 +1,4 @@
+import { type AnyType } from '../any';
 /**
  * The Error object is returned from the api any time there is an error.
  * The message contains
@@ -21,6 +22,6 @@ export type ApiErrorPayload = {
         /**
          * Optional data containing details of the error
          */
-        data?: any;
+        data?: AnyType;
     };
 };

package/dist/types/dbt.d.ts

@@ -1,6 +1,8 @@
 import { DepGraph } from 'dependency-graph';
+import { type AnyType } from './any';
 import { type ColumnInfo, type CompiledModelNode, type ParsedMetric } from './dbtFromSchema';
 import { type CompactOrAlias, type DimensionType, type FieldUrl, type Format, type Metric, type MetricType, type Source } from './field';
+import { type LightdashProjectConfig } from './lightdashProjectConfig';
 import { type OrderFieldsByStrategy } from './table';
 import { type DefaultTimeDimension, type TimeFrames } from './timeFrames';
 export declare enum SupportedDbtAdapter {
@@ -56,7 +58,7 @@ type DbtModelLightdashConfig = {
     sql_filter?: string;
     sql_where?: string;
     required_filters?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     }[];
     required_attributes?: Record<string, string | string[]>;
     group_details?: Record<string, DbtModelGroup>;
@@ -64,6 +66,9 @@ type DbtModelLightdashConfig = {
         field: string;
         interval: TimeFrames;
     };
+    spotlight?: {
+        visibility?: NonNullable<LightdashProjectConfig['spotlight']>['default_visibility'];
+    };
 };
 export type DbtModelGroup = {
     label: string;
@@ -122,10 +127,13 @@ export type DbtColumnLightdashMetric = {
     urls?: FieldUrl[];
     show_underlying_values?: string[];
     filters?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     }[];
     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;
@@ -164,7 +172,7 @@ export interface DbtRpcDocsGenerateResults {
         [k: string]: DbtCatalogNode;
     };
 }
-export declare const isDbtRpcDocsGenerateResults: (results: Record<string, any>) => results is DbtRpcDocsGenerateResults;
+export declare const isDbtRpcDocsGenerateResults: (results: Record<string, AnyType>) => results is DbtRpcDocsGenerateResults;
 export interface DbtPackage {
     package: string;
     version: string;
@@ -172,7 +180,7 @@ export interface DbtPackage {
 export interface DbtPackages {
     packages: DbtPackage[];
 }
-export declare const isDbtPackages: (results: Record<string, any>) => results is DbtPackages;
+export declare const isDbtPackages: (results: Record<string, AnyType>) => results is DbtPackages;
 export type V9MetricRef = {
     name: string;
     package?: string | null;
@@ -180,7 +188,7 @@ export type V9MetricRef = {
 };
 export declare const isV9MetricRef: (x: string[] | V9MetricRef) => x is V9MetricRef;
 export type DbtMetric = Omit<ParsedMetric, 'refs'> & {
-    meta?: Record<string, any> & DbtMetricLightdashMetadata;
+    meta?: Record<string, AnyType> & DbtMetricLightdashMetadata;
     refs?: string[][] | V9MetricRef[];
 };
 export type DbtMetricLightdashMetadata = {
@@ -188,7 +196,7 @@ export type DbtMetricLightdashMetadata = {
     group_label?: string;
     groups?: string[];
     show_underlying_values?: string[];
-    filters: Record<string, any>[];
+    filters: Record<string, AnyType>[];
 };
 export type DbtDoc = {
     unique_id: string;
@@ -214,18 +222,18 @@ export declare const isSupportedDbtAdapterType: (x: string) => x is SupportedDbt
 export interface DbtRpcGetManifestResults {
     manifest: DbtManifest;
 }
-export declare const isDbtRpcManifestResults: (results: Record<string, any>) => results is DbtRpcGetManifestResults;
+export declare const isDbtRpcManifestResults: (results: Record<string, AnyType>) => results is DbtRpcGetManifestResults;
 export interface DbtRpcCompileResults {
     results: {
         node: DbtNode;
     }[];
 }
-export declare const isDbtRpcCompileResults: (results: Record<string, any>) => results is DbtRpcCompileResults;
+export declare const isDbtRpcCompileResults: (results: Record<string, AnyType>) => results is DbtRpcCompileResults;
 export interface DbtRpcRunSqlResults {
     results: {
         table: {
             column_names: string[];
-            rows: any[][];
+            rows: AnyType[][];
         };
     }[];
 }
@@ -239,15 +247,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

@@ -122,7 +122,9 @@ const convertToGroups = (dbtGroups, dbtGroupLabel) => {
     return groups;
 };
 exports.convertToGroups = convertToGroups;
-const isDbtRpcRunSqlResults = (results) => 'results' in results &&
+const isDbtRpcRunSqlResults = (
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+results) => 'results' in results &&
     Array.isArray(results.results) &&
     results.results.every((result) => typeof result === 'object' &&
         result !== null &&
@@ -134,8 +136,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 +176,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 +211,7 @@ const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, met
             },
         }
         : null),
+    spotlightConfig,
 });
 exports.convertColumnMetric = convertColumnMetric;
 var DbtManifestVersion;

package/dist/types/errors.d.ts

@@ -1,32 +1,33 @@
+import { type AnyType } from './any';
 import { type DbtLog } from './job';
 type LightdashErrorParams = {
     message: string;
     name: string;
     statusCode: number;
     data: {
-        [key: string]: any;
+        [key: string]: AnyType;
     };
 };
 export declare class LightdashError extends Error {
     statusCode: number;
     data: {
-        [key: string]: any;
+        [key: string]: AnyType;
     };
     constructor({ message, name, statusCode, data }: LightdashErrorParams);
 }
 export declare class ForbiddenError extends LightdashError {
     constructor(message?: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class DeactivatedAccountError extends LightdashError {
     constructor(message?: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class AuthorizationError extends LightdashError {
     constructor(message?: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class NotExistsError extends LightdashError {
@@ -36,16 +37,16 @@ export declare class ExpiredError extends LightdashError {
     constructor(message: string);
 }
 export declare class ParameterError extends LightdashError {
-    constructor(message?: string, data?: Record<string, any>);
+    constructor(message?: string, data?: Record<string, AnyType>);
 }
 export declare class NonCompiledModelError extends LightdashError {
     constructor(message: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class MissingCatalogEntryError extends LightdashError {
     constructor(message: string, data: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class MissingWarehouseCredentialsError extends LightdashError {
@@ -53,29 +54,29 @@ export declare class MissingWarehouseCredentialsError extends LightdashError {
 }
 export declare class UnexpectedServerError extends LightdashError {
     constructor(message?: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class UnexpectedGitError extends LightdashError {
     constructor(message?: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class UnexpectedDatabaseError extends LightdashError {
     constructor(message?: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class ParseError extends LightdashError {
     constructor(message?: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class CompileError extends LightdashError {
-    constructor(message?: string, data?: Record<string, any>);
+    constructor(message?: string, data?: Record<string, AnyType>);
 }
 export declare class FieldReferenceError extends LightdashError {
-    constructor(message?: string, data?: Record<string, any>);
+    constructor(message?: string, data?: Record<string, AnyType>);
 }
 export declare class DbtError extends LightdashError {
     logs: DbtLog[] | undefined;
@@ -92,12 +93,12 @@ export declare class WarehouseConnectionError extends LightdashError {
 }
 export declare class WarehouseQueryError extends LightdashError {
     constructor(message: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class SmptError extends LightdashError {
     constructor(message: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare class AlreadyProcessingError extends LightdashError {
@@ -120,7 +121,7 @@ export declare class SlackInstallationNotFoundError extends LightdashError {
 }
 export declare class UnexpectedGoogleSheetsError extends LightdashError {
     constructor(message?: string, data?: {
-        [key: string]: any;
+        [key: string]: AnyType;
     });
 }
 export declare const getErrorMessage: (e: unknown) => string;

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,5 @@
-import type { AdditionalMetric, currencies, DefaultTimeDimension } from '..';
+import type { AdditionalMetric, currencies, DefaultTimeDimension, LightdashProjectConfig } from '..';
+import { type AnyType } from './any';
 import { type MetricFilterRule } from './filter';
 import { type TimeFrames } from './timeFrames';
 export declare enum Compact {
@@ -58,15 +59,15 @@ export interface CustomSqlDimension extends BaseCustomDimension {
     dimensionType: DimensionType;
 }
 export type CustomDimension = CustomBinDimension | CustomSqlDimension;
-export declare const isCustomDimension: (value: any) => value is CustomDimension;
-export declare const isCustomBinDimension: (value: any) => value is CustomBinDimension;
-export declare const isCustomSqlDimension: (value: any) => value is CustomSqlDimension;
+export declare const isCustomDimension: (value: AnyType) => value is CustomDimension;
+export declare const isCustomBinDimension: (value: AnyType) => value is CustomBinDimension;
+export declare const isCustomSqlDimension: (value: AnyType) => value is CustomSqlDimension;
 export type CompiledCustomSqlDimension = CustomSqlDimension & {
     compiledSql: string;
     tablesReferences: Array<string>;
 };
 export type CompiledCustomDimension = CustomBinDimension | CompiledCustomSqlDimension;
-export declare const isCompiledCustomSqlDimension: (value: any) => value is CompiledCustomSqlDimension;
+export declare const isCompiledCustomSqlDimension: (value: AnyType) => value is CompiledCustomSqlDimension;
 export type ItemsMap = Record<string, Field | TableCalculation | CustomDimension | Metric>;
 export type Item = ItemsMap[string];
 export interface CustomFormat {
@@ -142,7 +143,7 @@ export interface Field {
     index?: number;
     tags?: string[];
 }
-export declare const isField: (field: any) => field is Field;
+export declare const isField: (field: AnyType) => field is Field;
 export type FieldId = string;
 export declare const convertFieldRefToFieldId: (fieldRef: string, fallbackTableName?: string) => string;
 export type Source = {
@@ -222,6 +223,7 @@ export declare enum Format {
     GBP = "gbp",
     EUR = "eur",
     JPY = "jpy",
+    DKK = "dkk",
     ID = "id",
     PERCENT = "percent"
 }
@@ -240,6 +242,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/field.js

@@ -58,7 +58,8 @@ exports.CompactConfigMap = {
     },
 };
 function findCompactConfig(compactOrAlias) {
-    return Object.values(exports.CompactConfigMap).find(({ compact, alias }) => compact === compactOrAlias || alias.includes(compactOrAlias));
+    return Object.values(exports.CompactConfigMap).find(({ compact, alias }) => compact === compactOrAlias ||
+        alias.includes(compactOrAlias));
 }
 exports.findCompactConfig = findCompactConfig;
 var BinType;
@@ -170,6 +171,7 @@ var Format;
     Format["GBP"] = "gbp";
     Format["EUR"] = "eur";
     Format["JPY"] = "jpy";
+    Format["DKK"] = "dkk";
     Format["ID"] = "id";
     Format["PERCENT"] = "percent";
 })(Format = exports.Format || (exports.Format = {}));

package/dist/types/field.test.js

@@ -78,6 +78,7 @@ describe('field util functions', () => {
             expect((0, field_1.isFormat)('gbp')).toBe(true);
             expect((0, field_1.isFormat)('eur')).toBe(true);
             expect((0, field_1.isFormat)('jpy')).toBe(true);
+            expect((0, field_1.isFormat)('dkk')).toBe(true);
             expect((0, field_1.isFormat)('id')).toBe(true);
             expect((0, field_1.isFormat)('percent')).toBe(true);
         });

package/dist/types/filter.d.ts

@@ -1,3 +1,4 @@
+import { type AnyType } from './any';
 import { ConditionalOperator, type ConditionalRule } from './conditionalRule';
 import type { SchedulerFilterRule } from './scheduler';
 export declare enum FilterType {
@@ -22,7 +23,7 @@ export declare const getUnitsOfTimeGreaterOrEqual: (unit: UnitOfTime) => UnitOfT
 export type FieldTarget = {
     fieldId: string;
 };
-export interface FilterRule<O = ConditionalOperator, T = FieldTarget, V = any, S = any> extends ConditionalRule<O, V> {
+export interface FilterRule<O = ConditionalOperator, T = FieldTarget, V = AnyType, S = AnyType> extends ConditionalRule<O, V> {
     id: string;
     target: T;
     settings?: S;
@@ -38,7 +39,7 @@ export type DashboardFieldTarget = {
     tableName: string;
 };
 export type DashboardTileTarget = DashboardFieldTarget | false;
-export type DashboardFilterRule<O = ConditionalOperator, T extends DashboardFieldTarget = DashboardFieldTarget, V = any, S = any> = FilterRule<O, T, V, S> & {
+export type DashboardFilterRule<O = ConditionalOperator, T extends DashboardFieldTarget = DashboardFieldTarget, V = AnyType, S = AnyType> = FilterRule<O, T, V, S> & {
     tileTargets?: Record<string, DashboardTileTarget>;
     label: undefined | string;
 };
@@ -52,7 +53,7 @@ export type DateFilterSettings = {
     unitOfTime?: UnitOfTime;
     completed?: boolean;
 };
-export type DateFilterRule = FilterRule<ConditionalOperator, unknown, any, DateFilterSettings>;
+export type DateFilterRule = FilterRule<ConditionalOperator, unknown, AnyType, DateFilterSettings>;
 export type FilterGroupItem = FilterGroup | FilterRule;
 export type OrFilterGroup = {
     id: string;