@lightdash/common 0.1426.3 → 0.1427.0

package/dist/types/metricsExplorer.d.ts

@@ -1,6 +1,5 @@
 import { type MetricWithAssociatedTimeDimension } from './catalog';
 import type { Dimension, ItemsMap } from './field';
-import type { ResultValue } from './results';
 export declare enum MetricExplorerComparison {
     NONE = "none",
     PREVIOUS_PERIOD = "previous_period",
@@ -26,12 +25,10 @@ export type MetricExploreDataPoint = {
     segment: string | null;
     metric: {
         value: number | null;
-        formatted: string | null;
         label: string | null;
     };
     compareMetric: {
         value: number | null;
-        formatted: string | null;
         label: string | null;
     };
 };
@@ -55,8 +52,9 @@ export declare enum MetricTotalComparisonType {
     PREVIOUS_PERIOD = "previous_period"
 }
 export type MetricTotalResults = {
-    value: ResultValue | undefined;
-    comparisonValue: ResultValue | undefined;
+    value: number | null;
+    comparisonValue: number | null;
+    metric: MetricWithAssociatedTimeDimension;
 };
 export type ApiMetricsExplorerTotalResults = {
     status: 'ok';

package/dist/utils/metricsExplorer.d.ts

@@ -5,7 +5,6 @@ import type { Dimension } from '../types/field';
 import { DimensionType, type CompiledDimension, type CompiledMetric } from '../types/field';
 import { type DateFilterSettings, type FieldTarget, type FilterRule } from '../types/filter';
 import { type MetricExploreDataPoint, type MetricExplorerDateRange, type MetricExplorerQuery } from '../types/metricsExplorer';
-import type { ResultRow } from '../types/results';
 import { TimeFrames, type DefaultTimeDimension } from '../types/timeFrames';
 type DateFilter = FilterRule<ConditionalOperator, FieldTarget, unknown, DateFilterSettings>;
 type ImpelemntedTimeframe = TimeFrames.DAY | TimeFrames.WEEK | TimeFrames.MONTH | TimeFrames.YEAR;
@@ -20,12 +19,13 @@ export declare const METRICS_EXPLORER_DATE_FORMAT = "YYYY-MM-DD";
 export declare const getDateRangeFromString: (dateRange: [string, string]) => MetricExplorerDateRange;
 export declare const getGrainForDateRange: (dateRange: [Date, Date]) => ImpelemntedTimeframe;
 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: ResultRow[], segmentDimensionId: string | null) => {
+export declare const getMetricExplorerDataPoints: (dimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: Record<string, any>[], segmentDimensionId: string | null) => {
     dataPoints: Array<MetricExploreDataPoint>;
     isSegmentDimensionFiltered: boolean;
 };
-export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], compareMetricRows: ResultRow[], query: MetricExplorerQuery, timeFrame: TimeFrames) => {
+export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: Record<string, any>[], compareMetricRows: Record<string, any>[], query: MetricExplorerQuery, timeFrame: TimeFrames) => {
     dataPoints: Array<MetricExploreDataPoint>;
 };
 /**
@@ -38,7 +38,7 @@ export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimensi
  * @returns The date range
  */
 export declare const getDefaultDateRangeFromInterval: (timeInterval: TimeFrames) => MetricExplorerDateRange;
-export declare const getDefaultDateRangeForMetricTotal: (timeFrame: TimeFrames) => MetricExplorerDateRange;
+export declare const getDefaultMetricTreeNodeDateRange: (timeFrame: TimeFrames) => MetricExplorerDateRange;
 /**
  * Default time interval to use when no time interval is provided.
  * For example, when there is no default time dimension defined for a metric or table.

package/dist/utils/metricsExplorer.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAvailableCompareMetrics = exports.getAvailableSegmentDimensions = exports.getAvailableTimeDimensionsFromTables = exports.getDefaultTimeDimension = exports.getFirstAvailableTimeDimension = exports.DEFAULT_METRICS_EXPLORER_TIME_INTERVAL = exports.getDefaultDateRangeForMetricTotal = exports.getDefaultDateRangeFromInterval = exports.getMetricExplorerDataPointsWithCompare = exports.getMetricExplorerDataPoints = exports.MAX_SEGMENT_DIMENSION_UNIQUE_VALUES = exports.getMetricExplorerDateRangeFilters = exports.getGrainForDateRange = exports.getDateRangeFromString = exports.METRICS_EXPLORER_DATE_FORMAT = exports.getDateCalcUtils = exports.getFieldIdForDateDimension = exports.assertUnimplementedTimeframe = void 0;
+exports.getAvailableCompareMetrics = exports.getAvailableSegmentDimensions = exports.getAvailableTimeDimensionsFromTables = exports.getDefaultTimeDimension = exports.getFirstAvailableTimeDimension = exports.DEFAULT_METRICS_EXPLORER_TIME_INTERVAL = exports.getDefaultMetricTreeNodeDateRange = exports.getDefaultDateRangeFromInterval = exports.getMetricExplorerDataPointsWithCompare = exports.getMetricExplorerDataPoints = exports.MAX_SEGMENT_DIMENSION_UNIQUE_VALUES = exports.parseMetricValue = exports.getMetricExplorerDateRangeFilters = exports.getGrainForDateRange = exports.getDateRangeFromString = exports.METRICS_EXPLORER_DATE_FORMAT = exports.getDateCalcUtils = exports.getFieldIdForDateDimension = exports.assertUnimplementedTimeframe = void 0;
 const tslib_1 = require("tslib");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const isoWeek_1 = tslib_1.__importDefault(require("dayjs/plugin/isoWeek"));
@@ -135,7 +135,6 @@ const getMetricExplorerDateRangeFilters = (timeDimensionConfig, dateRange) => {
     ];
 };
 exports.getMetricExplorerDateRangeFilters = getMetricExplorerDateRangeFilters;
-// TODO: Should we just use the formatted value instead?
 // Parse the metric value to a number, returning null if it's not a number
 const parseMetricValue = (value) => {
     if (value === null || value === undefined)
@@ -143,6 +142,7 @@ const parseMetricValue = (value) => {
     const parsed = Number(value);
     return Number.isNaN(parsed) ? null : parsed;
 };
+exports.parseMetricValue = parseMetricValue;
 // we are assuming that the dimension value is a string and if it's not defined we just return null
 // so actually `null` value will be converted to `"null"` string
 const parseDimensionValue = (value) => {
@@ -157,28 +157,26 @@ const getMetricExplorerDataPoints = (dimension, metric, metricRows, segmentDimen
     let filteredMetricRows = metricRows;
     let isSegmentDimensionFiltered = false;
     if (segmentDimensionId) {
-        const countUniqueValues = new Set(metricRows.map((row) => row[segmentDimensionId]?.value.raw)).size;
+        const countUniqueValues = new Set(metricRows.map((row) => row[segmentDimensionId])).size;
         if (countUniqueValues > exports.MAX_SEGMENT_DIMENSION_UNIQUE_VALUES) {
             isSegmentDimensionFiltered = true;
-            const first10Values = Array.from(new Set(metricRows.map((row) => row[segmentDimensionId]?.value.raw))).slice(0, exports.MAX_SEGMENT_DIMENSION_UNIQUE_VALUES);
-            filteredMetricRows = metricRows.filter((row) => first10Values.includes(row[segmentDimensionId]?.value.raw));
+            const first10Values = Array.from(new Set(metricRows.map((row) => row[segmentDimensionId]))).slice(0, exports.MAX_SEGMENT_DIMENSION_UNIQUE_VALUES);
+            filteredMetricRows = metricRows.filter((row) => first10Values.includes(row[segmentDimensionId]));
         }
     }
-    const groupByMetricRows = (0, lodash_1.groupBy)(filteredMetricRows, (row) => new Date(String(row[dimensionId].value.raw)).toISOString());
+    const groupByMetricRows = (0, lodash_1.groupBy)(filteredMetricRows, (row) => new Date(String(row[dimensionId])).toISOString());
     const dataPoints = Object.entries(groupByMetricRows).flatMap(([date, rows]) => rows.map((row) => {
         const segmentValue = segmentDimensionId
-            ? parseDimensionValue(row[segmentDimensionId]?.value.raw)
+            ? parseDimensionValue(row[segmentDimensionId])
             : null;
         return {
             date: new Date(date),
             segment: segmentValue,
             metric: {
-                value: parseMetricValue(row[metricId]?.value.raw),
-                formatted: row[metricId]?.value.formatted,
+                value: (0, exports.parseMetricValue)(row[metricId]),
                 label: segmentValue ?? metric.label ?? metric.name,
             },
             compareMetric: {
-                formatted: null,
                 value: null,
                 label: null,
             },
@@ -208,8 +206,8 @@ const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, met
     const metricId = (0, item_1.getItemId)(metric);
     const dimensionId = (0, item_1.getItemId)(dimension);
     const compareDimensionId = (0, item_1.getItemId)(compareDimension);
-    const groupByMetricRows = (0, lodash_1.groupBy)(metricRows, (row) => new Date(String(row[dimensionId].value.raw)).toISOString());
-    const groupByCompareMetricRows = (0, lodash_1.groupBy)(compareMetricRows, (row) => new Date(String(row[compareDimensionId].value.raw)).toISOString());
+    const groupByMetricRows = (0, lodash_1.groupBy)(metricRows, (row) => new Date(String(row[dimensionId])).toISOString());
+    const groupByCompareMetricRows = (0, lodash_1.groupBy)(compareMetricRows, (row) => new Date(String(row[compareDimensionId])).toISOString());
     const offsetGroupByCompareMetricRows = (0, lodash_1.mapKeys)(groupByCompareMetricRows, (_, date) => {
         if (query.comparison === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD) {
             if (timeFrame === timeFrames_1.TimeFrames.WEEK) {
@@ -242,15 +240,11 @@ const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, met
         date: new Date(date),
         segment: null,
         metric: {
-            formatted: groupByMetricRows[date]?.[0]?.[metricId]?.value.formatted,
-            value: parseMetricValue(groupByMetricRows[date]?.[0]?.[metricId]?.value.raw),
+            value: (0, exports.parseMetricValue)(groupByMetricRows[date]?.[0]?.[metricId]),
             label: metric.label ?? metric.name,
         },
         compareMetric: {
-            formatted: offsetGroupByCompareMetricRows[date]?.[0]?.[compareMetricId]
-                ?.value.formatted,
-            value: parseMetricValue(offsetGroupByCompareMetricRows[date]?.[0]?.[compareMetricId]
-                ?.value.raw),
+            value: (0, exports.parseMetricValue)(offsetGroupByCompareMetricRows[date]?.[0]?.[compareMetricId]),
             label: comparisonMetricLabel,
         },
     }));
@@ -291,25 +285,34 @@ const getDefaultDateRangeFromInterval = (timeInterval) => {
     }
 };
 exports.getDefaultDateRangeFromInterval = getDefaultDateRangeFromInterval;
-const getDefaultDateRangeForMetricTotal = (timeFrame) => {
+const getDefaultMetricTreeNodeDateRange = (timeFrame) => {
     const now = (0, dayjs_1.default)();
     switch (timeFrame) {
         case timeFrames_1.TimeFrames.DAY:
-            return [now.startOf('day').toDate(), now.endOf('day').toDate()];
+            return [
+                now.startOf('day').subtract(1, 'day').toDate(),
+                now.endOf('day').subtract(1, 'day').toDate(),
+            ];
         case timeFrames_1.TimeFrames.WEEK:
             return [
-                now.startOf('isoWeek').toDate(),
-                now.endOf('isoWeek').toDate(),
+                now.startOf('isoWeek').subtract(1, 'week').toDate(),
+                now.endOf('isoWeek').subtract(1, 'week').toDate(),
             ];
         case timeFrames_1.TimeFrames.MONTH:
-            return [now.startOf('month').toDate(), now.endOf('month').toDate()];
+            return [
+                now.startOf('month').subtract(1, 'month').toDate(),
+                now.endOf('month').subtract(1, 'month').toDate(),
+            ];
         case timeFrames_1.TimeFrames.YEAR:
-            return [now.startOf('year').toDate(), now.endOf('year').toDate()];
+            return [
+                now.startOf('year').subtract(1, 'year').toDate(),
+                now.endOf('year').subtract(1, 'year').toDate(),
+            ];
         default:
             return (0, exports.assertUnimplementedTimeframe)(timeFrame);
     }
 };
-exports.getDefaultDateRangeForMetricTotal = getDefaultDateRangeForMetricTotal;
+exports.getDefaultMetricTreeNodeDateRange = getDefaultMetricTreeNodeDateRange;
 /**
  * Default time interval to use when no time interval is provided.
  * For example, when there is no default time dimension defined for a metric or table.

package/package.json

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