@lightdash/common 0.1462.2 → 0.1464.0

package/dist/types/filterGrammar.d.ts

@@ -1,11 +1,12 @@
+import { type AnyType } from './any';
 import { FilterOperator, type MetricFilterRule } from './filter';
 export type ParsedFilter = {
     type: string;
-    values: any[];
+    values: AnyType[];
     is?: boolean;
     date_interval?: string;
 };
 declare const filterGrammar: string;
 export declare const parseOperator: (operator: string, isTrue: boolean) => FilterOperator;
-export declare const parseFilters: (rawFilters: Record<string, any>[] | undefined) => MetricFilterRule[];
+export declare const parseFilters: (rawFilters: Record<string, AnyType>[] | undefined) => MetricFilterRule[];
 export default filterGrammar;

package/dist/types/lightdashProjectConfig.d.ts

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

package/dist/types/lightdashProjectConfig.js

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

package/dist/types/metricQuery.d.ts

@@ -1,3 +1,4 @@
+import { type AnyType } from './any';
 import { type CompactOrAlias, type CompiledCustomDimension, type CompiledDimension, type CompiledMetric, type CompiledTableCalculation, type CustomDimension, type CustomFormat, type FieldId, type Format, type Metric, type MetricType, type TableCalculation } from './field';
 import { type Filters, type MetricFilterRule } from './filter';
 import { type DateGranularity } from './timeFrames';
@@ -19,8 +20,8 @@ export interface AdditionalMetric {
     percentile?: number;
     formatOptions?: CustomFormat;
 }
-export declare const isAdditionalMetric: (value: any) => value is AdditionalMetric;
-export declare const hasFormatOptions: (value: any) => value is {
+export declare const isAdditionalMetric: (value: AnyType) => value is AdditionalMetric;
+export declare const hasFormatOptions: (value: AnyType) => value is {
     formatOptions: CustomFormat;
 };
 export declare const getCustomMetricDimensionId: (metric: AdditionalMetric) => string;
@@ -55,10 +56,10 @@ export type SortField = {
 export declare const getAdditionalMetricLabel: (item: AdditionalMetric) => string;
 type FilterGroupResponse = {
     id: string;
-    or: any[];
+    or: AnyType[];
 } | {
     id: string;
-    and: any[];
+    and: AnyType[];
 };
 export type FiltersResponse = {
     dimensions?: FilterGroupResponse;
@@ -91,9 +92,9 @@ export type MetricQueryRequest = {
     dimensions: FieldId[];
     metrics: FieldId[];
     filters: {
-        dimensions?: any;
-        metrics?: any;
-        tableCalculations?: any;
+        dimensions?: AnyType;
+        metrics?: AnyType;
+        tableCalculations?: AnyType;
     };
     sorts: SortField[];
     limit: number;

package/dist/types/scheduler.d.ts

@@ -1,3 +1,4 @@
+import { type AnyType } from './any';
 import { type Explore, type ExploreError } from './explore';
 import { type DashboardFilterRule } from './filter';
 import { type MetricQuery } from './metricQuery';
@@ -43,7 +44,7 @@ export type SchedulerLog = {
     status: SchedulerJobStatus;
     target?: string;
     targetType?: 'email' | 'slack' | 'gsheets';
-    details?: Record<string, any>;
+    details?: Record<string, AnyType>;
 };
 export type CreateSchedulerLog = Omit<SchedulerLog, 'createdAt'>;
 export declare enum ThresholdOperator {
@@ -283,7 +284,7 @@ export type ApiJobStatusResponse = {
     status: 'ok';
     results: {
         status: SchedulerJobStatus;
-        details: Record<string, any> | null;
+        details: Record<string, AnyType> | null;
     };
 };
 export type SchedulerCronUpdate = {

package/dist/types/user.d.ts

@@ -1,5 +1,6 @@
 import { type AbilityBuilder } from '@casl/ability';
 import { type MemberAbility } from '../authorization/types';
+import { type AnyType } from './any';
 import { type OpenIdIdentityIssuerType } from './openIdIdentity';
 import { type OrganizationMemberRole } from './organizationMemberProfile';
 export interface LightdashUser {
@@ -39,7 +40,7 @@ export interface UpdatedByUser {
     firstName: string;
     lastName: string;
 }
-export declare const isSessionUser: (user: any) => user is SessionUser;
+export declare const isSessionUser: (user: AnyType) => user is SessionUser;
 export interface OpenIdUser {
     openId: {
         subject: string;
@@ -51,7 +52,7 @@ export interface OpenIdUser {
         groups?: string[] | undefined;
     };
 }
-export declare const isOpenIdUser: (user: any) => user is OpenIdUser;
+export declare const isOpenIdUser: (user: AnyType) => user is OpenIdUser;
 export type UserAllowedOrganization = {
     organizationUuid: string;
     name: string;

package/dist/types/warehouse.d.ts

@@ -1,4 +1,5 @@
 import { type WeekDay } from '../utils/timeFrames';
+import { type AnyType } from './any';
 import { type SupportedDbtAdapter } from './dbt';
 import { type DimensionType, type Metric } from './field';
 import { type CreateWarehouseCredentials } from './projects';
@@ -31,7 +32,7 @@ export type WarehouseResults = {
     fields: Record<string, {
         type: DimensionType;
     }>;
-    rows: Record<string, any>[];
+    rows: Record<string, AnyType>[];
 };
 export interface WarehouseClient {
     credentials: CreateWarehouseCredentials;
@@ -41,7 +42,7 @@ export interface WarehouseClient {
         table: string;
     }[]) => Promise<WarehouseCatalog>;
     streamQuery(query: string, streamCallback: (data: WarehouseResults) => void, options: {
-        values?: any[];
+        values?: AnyType[];
         tags: Record<string, string>;
         timezone?: string;
     }): Promise<void>;
@@ -53,7 +54,7 @@ export interface WarehouseClient {
      * @param values
      * @deprecated Use streamQuery() instead to avoid loading all results into memory
      */
-    runQuery(sql: string, tags: Record<string, string>, timezone?: string, values?: any[]): Promise<WarehouseResults>;
+    runQuery(sql: string, tags: Record<string, string>, timezone?: string, values?: AnyType[]): Promise<WarehouseResults>;
     test(): Promise<void>;
     getStartOfWeek(): WeekDay | null | undefined;
     getAdapterType(): SupportedDbtAdapter;
@@ -63,7 +64,7 @@ export interface WarehouseClient {
     concatString(...args: string[]): string;
     getAllTables(schema?: string, tags?: Record<string, string>): Promise<WarehouseTables>;
     getFields(tableName: string, schema?: string, database?: string, tags?: Record<string, string>): Promise<WarehouseCatalog>;
-    parseWarehouseCatalog(rows: Record<string, any>[], mapFieldType: (type: string) => DimensionType): WarehouseCatalog;
+    parseWarehouseCatalog(rows: Record<string, AnyType>[], mapFieldType: (type: string) => DimensionType): WarehouseCatalog;
     parseError(error: Error): Error;
 }
 export type ApiWarehouseCatalog = {

package/dist/utils/filters.d.ts

@@ -1,3 +1,4 @@
+import { type AnyType } from '../types/any';
 import { type DashboardTile } from '../types/dashboard';
 import { type Table } from '../types/explore';
 import { type CompiledField, type CustomSqlDimension, type Dimension, type Field, type FilterableDimension, type FilterableField, type FilterableItem, type ItemsMap, type TableCalculation } from '../types/field';
@@ -12,13 +13,13 @@ export declare const getItemsFromFilterGroup: (filterGroup: FilterGroup | undefi
 export declare const getFilterGroupItemsPropertyName: (filterGroup: FilterGroup | undefined) => 'and' | 'or';
 export declare const getFilterTypeFromItem: (item: FilterableField) => FilterType;
 export declare const timeframeToUnitOfTime: (timeframe: TimeFrames) => UnitOfTime | undefined;
-export declare const getFilterRuleWithDefaultValue: <T extends FilterRule<FilterOperator, import("../types/filter").FieldTarget, any, any>>(field: FilterableField, filterRule: T, values?: any[] | null) => T;
-export declare const createFilterRuleFromField: (field: FilterableField, value?: any) => FilterRule;
+export declare const getFilterRuleWithDefaultValue: <T extends FilterRule<FilterOperator, import("../types/filter").FieldTarget, any, any>>(field: FilterableField, filterRule: T, values?: AnyType[] | null) => T;
+export declare const createFilterRuleFromField: (field: FilterableField, value?: AnyType) => FilterRule;
 export declare const matchFieldExact: (a: Field) => (b: Field) => boolean;
 export declare const matchFieldByTypeAndName: (a: Field) => (b: Field) => boolean;
 export declare const matchFieldByType: (a: Field) => (b: Field) => boolean;
 export declare const isTileFilterable: (tile: DashboardTile) => boolean;
-export declare const applyDefaultTileTargets: (filterRule: DashboardFilterRule<FilterOperator, DashboardFieldTarget, any, any>, field: FilterableDimension, availableTileFilters: Record<string, FilterableDimension[] | undefined>) => DashboardFilterRule<FilterOperator, DashboardFieldTarget, any, any>;
+export declare const applyDefaultTileTargets: (filterRule: DashboardFilterRule<FilterOperator, DashboardFieldTarget, AnyType, AnyType>, field: FilterableDimension, availableTileFilters: Record<string, FilterableDimension[] | undefined>) => DashboardFilterRule<FilterOperator, DashboardFieldTarget, any, any>;
 export declare const createDashboardFilterRuleFromField: ({ field, availableTileFilters, isTemporary, value, }: {
     field: Exclude<FilterableItem, TableCalculation | CustomSqlDimension> | CompiledField;
     availableTileFilters: Record<string, FilterableDimension[] | undefined>;
@@ -28,7 +29,7 @@ export declare const createDashboardFilterRuleFromField: ({ field, availableTile
 type AddFilterRuleArgs = {
     filters: Filters;
     field: FilterableField;
-    value?: any;
+    value?: AnyType;
 };
 export declare const addFilterRule: ({ filters, field, value, }: AddFilterRuleArgs) => Filters;
 /**
@@ -37,7 +38,7 @@ export declare const addFilterRule: ({ filters, field, value, }: AddFilterRuleAr
  * @param value - The value to check
  * @returns True if the value is an invalid date, false otherwise
  */
-export declare const isDimensionValueInvalidDate: (item: FilterableField, value: any) => boolean;
+export declare const isDimensionValueInvalidDate: (item: FilterableField, value: AnyType) => boolean;
 /**
  * Takes a filter group and build a filters object from it based on the field type
  * @param filterGroup - The filter group to extract filters from

package/dist/utils/formatting.js

@@ -16,6 +16,7 @@ exports.currencies = [
     'EUR',
     'GBP',
     'JPY',
+    'DKK',
     'CHF',
     'CAD',
     'AUD',
@@ -25,7 +26,6 @@ exports.currencies = [
     'CLP',
     'COP',
     'CZK',
-    'DKK',
     'HKD',
     'HUF',
     'INR',
@@ -188,6 +188,7 @@ function getCustomFormatFromLegacy({ format, compact, round, }) {
         case field_1.Format.GBP:
         case field_1.Format.USD:
         case field_1.Format.JPY:
+        case field_1.Format.DKK:
             return {
                 type: field_1.CustomFormatType.CURRENCY,
                 currency: format.toUpperCase(),

package/dist/utils/formatting.test.js

@@ -67,6 +67,10 @@ describe('Formatting', () => {
                     type: field_1.CustomFormatType.CURRENCY,
                     currency: field_1.Format.JPY,
                 })).toEqual('¥5');
+                expect((0, formatting_1.applyCustomFormat)(5, {
+                    type: field_1.CustomFormatType.CURRENCY,
+                    currency: field_1.Format.DKK,
+                })).toEqual('DKK 5.00');
             });
             test('if Format is percent it should return the right format', () => {
                 const percentFormat = {
@@ -653,6 +657,7 @@ describe('Formatting', () => {
                 '€1.00',
                 '£1.00',
                 '¥1',
+                'DKK 1.00',
                 'CHF 1.00',
                 'CA$1.00',
                 'A$1.00',
@@ -662,7 +667,6 @@ describe('Formatting', () => {
                 'CLP 1',
                 'COP 1.00',
                 'CZK 1.00',
-                'DKK 1.00',
                 'HK$1.00',
                 'HUF 1.00',
                 '₹1.00',

package/dist/utils/item.d.ts

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

package/dist/utils/loadLightdashProjectConfig.d.ts

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

package/dist/utils/loadLightdashProjectConfig.js

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

package/dist/utils/metricsExplorer.d.ts

@@ -1,3 +1,4 @@
+import { type AnyType } from '../types/any';
 import type { MetricWithAssociatedTimeDimension } from '../types/catalog';
 import { ConditionalOperator } from '../types/conditionalRule';
 import { type CompiledTable } from '../types/explore';
@@ -21,11 +22,11 @@ export declare const getMetricsExplorerSegmentFilters: (segmentDimension: string
 export declare const getMetricExplorerDateRangeFilters: (timeDimensionConfig: TimeDimensionConfig, dateRange: MetricExplorerDateRange) => DateFilter[];
 export declare const parseMetricValue: (value: unknown) => number | null;
 export declare const MAX_SEGMENT_DIMENSION_UNIQUE_VALUES = 10;
-export declare const getMetricExplorerDataPoints: (dimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: Record<string, any>[], segmentDimensionId: string | null) => {
+export declare const getMetricExplorerDataPoints: (dimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: Record<string, AnyType>[], segmentDimensionId: string | null) => {
     dataPoints: Array<MetricExploreDataPoint>;
     isSegmentDimensionFiltered: boolean;
 };
-export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: Record<string, any>[], compareMetricRows: Record<string, any>[], query: MetricExplorerQuery, timeFrame: TimeFrames) => {
+export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: Record<string, AnyType>[], compareMetricRows: Record<string, AnyType>[], query: MetricExplorerQuery, timeFrame: TimeFrames) => {
     dataPoints: Array<MetricExploreDataPoint>;
 };
 /**

package/dist/utils/virtualView.js

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

package/dist/visualizations/CartesianChartDataModel.d.ts

@@ -1,9 +1,10 @@
+import { type AnyType } from '../types/any';
 import { Format } from '../types/field';
 import { type Organization } from '../types/organization';
 import { type RawResultRow } from '../types/results';
 import { ChartKind, type CartesianSeriesType } from '../types/savedCharts';
 import { type SemanticLayerQuery } from '../types/semanticLayer';
-import { type AxisSide, VizIndexType, type PivotChartData, type PivotChartLayout, type VizCartesianChartConfig, type VizCartesianChartOptions } from './types';
+import { VizIndexType, type AxisSide, type PivotChartData, type PivotChartLayout, type VizCartesianChartConfig, type VizCartesianChartOptions } from './types';
 import { type IResultsRunner } from './types/IResultsRunner';
 type CartesianChartKind = Extract<ChartKind, ChartKind.LINE | ChartKind.VERTICAL_BAR>;
 export declare class CartesianChartDataModel {
@@ -17,7 +18,7 @@ export declare class CartesianChartDataModel {
         type?: CartesianChartKind;
     });
     static getTooltipFormatter(format: Format | undefined): ((value: number) => string) | undefined;
-    static getValueFormatter(format: Format | undefined): ((params: any) => string) | undefined;
+    static getValueFormatter(format: Format | undefined): ((params: AnyType) => string) | undefined;
     mergeConfig(chartKind: CartesianChartKind, existingConfig: VizCartesianChartConfig | undefined): VizCartesianChartConfig;
     getChartOptions(): VizCartesianChartOptions;
     getDefaultLayout(): PivotChartLayout | undefined;
@@ -43,7 +44,7 @@ export declare class CartesianChartDataModel {
         rows: RawResultRow[];
     } | undefined;
     getDataDownloadUrl(): string | undefined;
-    getSpec(display?: CartesianChartDisplay, colors?: Organization['chartColors']): Record<string, any>;
+    getSpec(display?: CartesianChartDisplay, colors?: Organization['chartColors']): Record<string, AnyType>;
 }
 export declare enum ValueLabelPositionOptions {
     HIDDEN = "hidden",

package/dist/visualizations/PieChartDataModel.d.ts

@@ -1,3 +1,4 @@
+import { type AnyType } from '../types/any';
 import { type RawResultRow } from '../types/results';
 import { type ChartKind } from '../types/savedCharts';
 import { type SemanticLayerQuery } from '../types/semanticLayer';
@@ -36,5 +37,5 @@ export declare class PieChartDataModel {
         rows: RawResultRow[];
     } | undefined;
     getDataDownloadUrl(): string | undefined;
-    getSpec(display?: VizPieChartDisplay): Record<string, any>;
+    getSpec(display?: VizPieChartDisplay): Record<string, AnyType>;
 }

package/dist/visualizations/TableDataModel.d.ts

@@ -1,3 +1,4 @@
+import { type AnyType } from '../types/any';
 import { type RawResultRow } from '../types/results';
 import { type ChartKind } from '../types/savedCharts';
 import { type SemanticLayerQuery } from '../types/semanticLayer';
@@ -29,7 +30,7 @@ export declare class TableDataModel {
         rows: RawResultRow[];
     } | undefined;
     getSpec(_display?: VizTableDisplay): {
-        spec: Record<string, any>;
+        spec: Record<string, AnyType>;
         tableData: {
             columns: string[];
             rows: RawResultRow[];

package/package.json

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