@lightdash/common 0.1372.0 → 0.1372.2

package/dist/compiler/translator.js

@@ -333,6 +333,14 @@ const convertTable = (adapterType, model, dbtMetrics, startOfWeek) => {
         requiredFilters: (0, filterGrammar_1.parseFilters)(meta.required_filters),
         requiredAttributes: meta.required_attributes,
         groupDetails,
+        ...(meta.default_time_dimension
+            ? {
+                defaultTimeDimension: {
+                    field: meta.default_time_dimension.field,
+                    interval: meta.default_time_dimension.interval,
+                },
+            }
+            : {}),
     };
 };
 exports.convertTable = convertTable;

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

@@ -165,6 +165,27 @@
                                         "required": ["type", "sql"]
                                     }
                                 }
+                            },
+                            "default_time_dimension": {
+                                "type": "object",
+                                "description": "Specifies the default time dimension field and interval to use for time-based analysis (on any metric in the model). If specified, both field and interval are required.",
+                                "properties": {
+                                    "field": {
+                                        "type": "string",
+                                        "description": "The name of the field to use as the default time dimension"
+                                    },
+                                    "interval": {
+                                        "type": "string",
+                                        "enum": [
+                                            "DAY",
+                                            "WEEK",
+                                            "MONTH",
+                                            "YEAR"
+                                        ],
+                                        "description": "The default time interval to use when analyzing this time dimension"
+                                    }
+                                },
+                                "required": ["field", "interval"]
                             }
                         }
                     },

package/dist/types/dbt.d.ts

@@ -60,6 +60,10 @@ type DbtModelLightdashConfig = {
     }[];
     required_attributes?: Record<string, string | string[]>;
     group_details?: Record<string, DbtModelGroup>;
+    default_time_dimension?: {
+        field: string;
+        interval: TimeFrames;
+    };
 };
 export type DbtModelGroup = {
     label: string;

package/dist/types/table.d.ts

@@ -1,4 +1,5 @@
 import { type MetricFilterRule } from './filter';
+import type { TimeFrames } from './timeFrames';
 export declare enum OrderFieldsByStrategy {
     LABEL = "LABEL",
     INDEX = "INDEX"
@@ -22,4 +23,8 @@ export type TableBase = {
     hidden?: boolean;
     requiredAttributes?: Record<string, string | string[]>;
     groupDetails?: Record<string, GroupType>;
+    defaultTimeDimension?: {
+        field: string;
+        interval: TimeFrames;
+    };
 };

package/dist/utils/item.d.ts

@@ -30,6 +30,10 @@ export declare const replaceDimensionInExplore: (explore: Explore, dimension: Co
             hidden?: boolean | undefined;
             requiredAttributes?: Record<string, string | string[]> | undefined;
             groupDetails?: Record<string, import("..").GroupType> | undefined;
+            defaultTimeDimension?: {
+                field: string;
+                interval: import("..").TimeFrames;
+            } | undefined;
             metrics: Record<string, import("../types/field").CompiledMetric>;
             lineageGraph: import("..").LineageGraph;
             source?: import("../types/field").Source | undefined;

package/dist/visualizations/CartesianChartDataModel.d.ts

@@ -17,6 +17,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;
     mergeConfig(chartKind: CartesianChartKind, existingConfig: VizCartesianChartConfig | undefined): VizCartesianChartConfig;
     getChartOptions(): VizCartesianChartOptions;
     getDefaultLayout(): PivotChartLayout | undefined;

package/dist/visualizations/CartesianChartDataModel.js

@@ -27,6 +27,7 @@ class CartesianChartDataModel {
         this.fieldConfig = args.fieldConfig ?? defaultFieldConfig;
         this.type = args.type ?? savedCharts_1.ChartKind.VERTICAL_BAR;
     }
+    // Get the formatter for the tooltip, which has a simple callback signature
     static getTooltipFormatter(format) {
         if (format === field_1.Format.PERCENT) {
             return (value) => (0, formatting_1.applyCustomFormat)(value, {
@@ -35,6 +36,20 @@ class CartesianChartDataModel {
         }
         return undefined;
     }
+    // Get the formatter for the value label,
+    // which has more complex inputs
+    static getValueFormatter(format) {
+        if (format === field_1.Format.PERCENT) {
+            // Echarts doesn't export the types for this function
+            return (params) => {
+                const value = params.value[params.dimensionNames[params.encode.y[0]]];
+                return (0, formatting_1.applyCustomFormat)(value, {
+                    type: field_1.CustomFormatType.PERCENT,
+                });
+            };
+        }
+        return undefined;
+    }
     mergeConfig(chartKind, existingConfig) {
         const newDefaultLayout = this.getDefaultLayout();
         const someFieldsMatch = existingConfig?.fieldConfig?.x?.reference ===
@@ -314,6 +329,9 @@ class CartesianChartDataModel {
                     ? {
                         show: seriesValueLabelPosition !== 'hidden',
                         position: seriesValueLabelPosition,
+                        formatter: seriesFormat
+                            ? CartesianChartDataModel.getValueFormatter(seriesFormat)
+                            : undefined,
                     }
                     : undefined,
                 labelLayout: {

package/package.json

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