@lightdash/common 0.1411.0 → 0.1411.2

package/dist/types/metricsExplorer.d.ts

@@ -15,30 +15,69 @@ export type MetricExplorerComparisonType = {
     type: MetricExplorerComparison.PREVIOUS_PERIOD;
 } | {
     type: MetricExplorerComparison.DIFFERENT_METRIC;
-    metricTable: string;
-    metricName: string;
+    metric: {
+        label: string;
+        table: string;
+        name: string;
+    };
 };
 export declare const metricExploreDataPointWithDateValueSchema: z.ZodObject<z.objectUtil.extendShape<{
     date: z.ZodDate;
-    metric: z.ZodNullable<z.ZodNumber>;
-    compareMetric: z.ZodNullable<z.ZodNumber>;
+    metric: z.ZodObject<{
+        value: z.ZodNullable<z.ZodNumber>;
+        label: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string | null;
+        value: number | null;
+    }, {
+        label: string | null;
+        value: number | null;
+    }>;
+    compareMetric: z.ZodObject<{
+        value: z.ZodNullable<z.ZodNumber>;
+        label: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string | null;
+        value: number | null;
+    }, {
+        label: string | null;
+        value: number | null;
+    }>;
 }, {
     dateValue: z.ZodNumber;
 }>, "strip", z.ZodTypeAny, {
-    metric: number | null;
+    metric: {
+        label: string | null;
+        value: number | null;
+    };
     date: Date;
-    compareMetric: number | null;
+    compareMetric: {
+        label: string | null;
+        value: number | null;
+    };
     dateValue: number;
 }, {
-    metric: number | null;
+    metric: {
+        label: string | null;
+        value: number | null;
+    };
     date: Date;
-    compareMetric: number | null;
+    compareMetric: {
+        label: string | null;
+        value: number | null;
+    };
     dateValue: number;
 }>;
 export type MetricExploreDataPoint = {
     date: Date;
-    metric: number | null;
-    compareMetric: number | null;
+    metric: {
+        value: number | null;
+        label: string | null;
+    };
+    compareMetric: {
+        value: number | null;
+        label: string | null;
+    };
 };
 export type MetricExploreDataPointWithDateValue = MetricExploreDataPoint & {
     dateValue: number;

package/dist/types/metricsExplorer.js

@@ -10,8 +10,14 @@ var MetricExplorerComparison;
 })(MetricExplorerComparison = exports.MetricExplorerComparison || (exports.MetricExplorerComparison = {}));
 const metricExploreDataPointSchema = zod_1.z.object({
     date: zod_1.z.date({ coerce: true }),
-    metric: zod_1.z.number().nullable(),
-    compareMetric: zod_1.z.number().nullable(),
+    metric: zod_1.z.object({
+        value: zod_1.z.number().nullable(),
+        label: zod_1.z.string().nullable(),
+    }),
+    compareMetric: zod_1.z.object({
+        value: zod_1.z.number().nullable(),
+        label: zod_1.z.string().nullable(),
+    }),
 });
 exports.metricExploreDataPointWithDateValueSchema = metricExploreDataPointSchema.extend({
     dateValue: zod_1.z.number(),

package/dist/utils/metricsExplorer.js

@@ -130,8 +130,14 @@ const getMetricExplorerDataPoints = (dimension, metric, metricRows) => {
     const groupByMetricRows = (0, lodash_1.groupBy)(metricRows, (row) => new Date(String(row[dimensionId].value.raw)).toISOString());
     return Object.keys(groupByMetricRows).map((date) => ({
         date: new Date(date),
-        metric: parseMetricValue(groupByMetricRows[date]?.[0]?.[metricId]?.value.raw),
-        compareMetric: null,
+        metric: {
+            value: parseMetricValue(groupByMetricRows[date]?.[0]?.[metricId]?.value.raw),
+            label: metric.label ?? metric.name,
+        },
+        compareMetric: {
+            value: null,
+            label: null,
+        },
     }));
 };
 exports.getMetricExplorerDataPoints = getMetricExplorerDataPoints;
@@ -156,14 +162,28 @@ const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, met
     const compareMetricId = comparison.type === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD
         ? metricId
         : (0, item_1.getItemId)({
-            table: comparison.metricTable,
-            name: comparison.metricName,
+            table: comparison.metric.table,
+            name: comparison.metric.name,
         });
+    let comparisonMetricLabel = null;
+    if (comparison.type === metricsExplorer_1.MetricExplorerComparison.DIFFERENT_METRIC) {
+        comparisonMetricLabel =
+            comparison.metric.label ?? comparison.metric.name;
+    }
+    else if (comparison.type === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD) {
+        comparisonMetricLabel = 'Previous Period';
+    }
     return Array.from(dates).map((date) => ({
         date: new Date(date),
-        metric: parseMetricValue(groupByMetricRows[date]?.[0]?.[metricId]?.value.raw),
-        compareMetric: parseMetricValue(offsetGroupByCompareMetricRows[date]?.[0]?.[compareMetricId]?.value
-            .raw),
+        metric: {
+            value: parseMetricValue(groupByMetricRows[date]?.[0]?.[metricId]?.value.raw),
+            label: metric.label ?? metric.name,
+        },
+        compareMetric: {
+            value: parseMetricValue(offsetGroupByCompareMetricRows[date]?.[0]?.[compareMetricId]
+                ?.value.raw),
+            label: comparisonMetricLabel,
+        },
     }));
 };
 exports.getMetricExplorerDataPointsWithCompare = getMetricExplorerDataPointsWithCompare;

package/package.json

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