@lightdash/common 0.1390.1 → 0.1392.0

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

@@ -134,6 +134,7 @@
                                                 "type": "boolean"
                                             },
                                             "round": {
+                                                "description": "Rounds the metric to the specified number of decimal places",
                                                 "type": "number",
                                                 "minimum": 0
                                             },
@@ -160,6 +161,30 @@
                                                     "minLength": 1
                                                 },
                                                 "maxItems": 3
+                                            },
+                                            "default_time_dimension": {
+                                                "type": "object",
+                                                "description": "Specifies the default time dimension field and interval to use for time-based analysis on this metric. If specified, both field and interval are required. If there is already a default time dimension set in the model, this will override it.",
+                                                "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"
+                                                ]
                                             }
                                         },
                                         "required": ["type", "sql"]
@@ -303,6 +328,30 @@
                                                                 "minLength": 1
                                                             },
                                                             "maxItems": 3
+                                                        },
+                                                        "default_time_dimension": {
+                                                            "type": "object",
+                                                            "description": "Specifies the default time dimension field and interval to use for time-based analysis on this metric. If specified, both field and interval are required. If there is already a default time dimension set in the model, this will override it.",
+                                                            "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"
+                                                            ]
                                                         }
                                                     },
                                                     "required": ["type"]
@@ -552,6 +601,27 @@
                                     "percent",
                                     "id"
                                 ]
+                            },
+                            "default_time_dimension": {
+                                "type": "object",
+                                "description": "Specifies the default time dimension field and interval to use for time-based analysis on this metric. If specified, both field and interval are required. If there is already a default time dimension set in the model, this will override it.",
+                                "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/coder.d.ts

@@ -1,4 +1,4 @@
-import type { PromotionChanges, SavedChart } from '..';
+import type { Dashboard, DashboardTile, PromotionChanges, SavedChart } from '..';
 export declare const currentVersion = 1;
 export type ChartAsCode = Pick<SavedChart, 'name' | 'description' | 'tableName' | 'metricQuery' | 'chartConfig' | 'tableConfig' | 'slug' | 'dashboardUuid' | 'updatedAt'> & {
     version: number;
@@ -13,3 +13,20 @@ export type ApiChartAsCodeUpsertResponse = {
     status: 'ok';
     results: PromotionChanges;
 };
+export type DashboardTileWithoutUuids = Omit<DashboardTile, 'properties'> & {
+    properties: Omit<DashboardTile['properties'], 'savedChartUuid' | 'savedSqlUuid' | 'savedSemanticViewerChartUuid'>;
+};
+export type DashboardAsCode = Pick<Dashboard, 'name' | 'description' | 'updatedAt' | 'filters' | 'tabs' | 'slug'> & {
+    tiles: DashboardTileWithoutUuids[];
+    version: number;
+    spaceSlug: string;
+    downloadedAt?: Date;
+};
+export type ApiDashboardAsCodeListResponse = {
+    status: 'ok';
+    results: DashboardAsCode[];
+};
+export type ApiDashboardAsCodeUpsertResponse = {
+    status: 'ok';
+    results: PromotionChanges;
+};

package/dist/types/dashboard.d.ts

@@ -45,6 +45,7 @@ export type DashboardChartTileProperties = {
         belongsToDashboard?: boolean;
         chartName?: string | null;
         lastVersionChartKind?: ChartKind | null;
+        chartSlug?: string;
     };
 };
 export type DashboardSqlChartTileProperties = {
@@ -54,6 +55,7 @@ export type DashboardSqlChartTileProperties = {
         savedSqlUuid: string | null;
         chartName: string;
         hideTitle?: boolean;
+        chartSlug?: string;
     };
 };
 export type DashboardSemanticViewerChartTileProperties = {
@@ -63,6 +65,7 @@ export type DashboardSemanticViewerChartTileProperties = {
         savedSemanticViewerChartUuid: string | null;
         chartName: string;
         hideTitle?: boolean;
+        chartSlug?: string;
     };
 };
 export type CreateDashboardMarkdownTile = CreateDashboardTileBase & DashboardMarkdownTileProperties;

package/dist/types/dbt.d.ts

@@ -2,7 +2,7 @@ import { DepGraph } from 'dependency-graph';
 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 OrderFieldsByStrategy } from './table';
-import { type TimeFrames } from './timeFrames';
+import { type DefaultTimeDimension, type TimeFrames } from './timeFrames';
 export declare enum SupportedDbtAdapter {
     BIGQUERY = "bigquery",
     DATABRICKS = "databricks",
@@ -125,6 +125,7 @@ export type DbtColumnLightdashMetric = {
         [key: string]: any;
     }[];
     percentile?: number;
+    default_time_dimension?: DefaultTimeDimension;
 } & DbtLightdashFieldTags;
 export type DbtModelLightdashMetric = DbtColumnLightdashMetric & Required<Pick<DbtColumnLightdashMetric, 'sql'>>;
 export declare const normaliseModelDatabase: (model: DbtRawModelNode, targetWarehouse: SupportedDbtAdapter) => DbtModelNode;

package/dist/types/dbt.js

@@ -165,6 +165,14 @@ const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimen
                     : [metric.tags],
             }
             : {}),
+        ...(metric.default_time_dimension
+            ? {
+                defaultTimeDimension: {
+                    field: metric.default_time_dimension.field,
+                    interval: metric.default_time_dimension.interval,
+                },
+            }
+            : {}),
     };
 };
 exports.convertModelMetric = convertModelMetric;
@@ -185,6 +193,14 @@ const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, met
         ? (0, item_1.getItemId)({ table: modelName, name: dimensionName })
         : undefined,
     requiredAttributes,
+    ...(metric.default_time_dimension
+        ? {
+            defaultTimeDimension: {
+                field: metric.default_time_dimension.field,
+                interval: metric.default_time_dimension.interval,
+            },
+        }
+        : {}),
 });
 exports.convertColumnMetric = convertColumnMetric;
 var DbtManifestVersion;

package/dist/types/field.d.ts

@@ -1,4 +1,4 @@
-import type { AdditionalMetric, currencies } from '..';
+import type { AdditionalMetric, currencies, DefaultTimeDimension } from '..';
 import { type MetricFilterRule } from './filter';
 import { type TimeFrames } from './timeFrames';
 export declare enum Compact {
@@ -238,6 +238,7 @@ export interface Metric extends Field {
     formatOptions?: CustomFormat;
     dimensionReference?: string;
     requiredAttributes?: Record<string, string | string[]>;
+    defaultTimeDimension?: DefaultTimeDimension;
 }
 export declare const isFilterableDimension: (dimension: Dimension) => dimension is FilterableDimension;
 export type FilterableField = TableCalculation | Metric | FilterableDimension | CustomSqlDimension;

package/dist/types/table.d.ts

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

package/dist/types/timeFrames.d.ts

@@ -30,3 +30,7 @@ export declare enum DateGranularity {
     YEAR = "Year"
 }
 export declare const dateGranularityToTimeFrameMap: Record<DateGranularity, TimeFrames>;
+export type DefaultTimeDimension = {
+    field: string;
+    interval: TimeFrames;
+};

package/dist/utils/item.d.ts

@@ -30,10 +30,7 @@ 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;
+            defaultTimeDimension?: import("..").DefaultTimeDimension | undefined;
             metrics: Record<string, import("../types/field").CompiledMetric>;
             lineageGraph: import("..").LineageGraph;
             source?: import("../types/field").Source | undefined;

package/package.json

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