@lightdash/common 0.1398.0 → 0.1399.0

package/dist/types/metricsExplorer.d.ts

@@ -14,6 +14,7 @@ export type MetricExplorerComparisonType = {
     type: MetricExplorerComparison.PREVIOUS_PERIOD;
 } | {
     type: MetricExplorerComparison.DIFFERENT_METRIC;
+    metricTable: string;
     metricName: string;
 };
 export type MetricExploreDataPoint = {

package/dist/utils/metricsExplorer.d.ts

@@ -4,7 +4,7 @@ import { type CompiledTable } from '../types/explore';
 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, MetricExplorerDateRange } from '../types/metricsExplorer';
+import { type MetricExploreDataPoint, type MetricExplorerComparisonType, type MetricExplorerDateRange } from '../types/metricsExplorer';
 import type { ResultRow } from '../types/results';
 import { TimeFrames, type DefaultTimeDimension } from '../types/timeFrames';
 type DateFilter = FilterRule<ConditionalOperator, FieldTarget, unknown, DateFilterSettings>;
@@ -15,7 +15,7 @@ export declare const oneYearForward: (date: Date) => Date;
 export declare const getGrainForDateRange: (dateRange: [Date, Date]) => ImpelemntedTimeframe;
 export declare const getMetricExplorerDateRangeFilters: (exploreName: string, dimensionName: string, dateRange: MetricExplorerDateRange) => DateFilter[];
 export declare const getMetricExplorerDataPoints: (dimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[]) => Array<MetricExploreDataPoint>;
-export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], compareMetricRows: ResultRow[], offsetFunction?: (date: Date) => Date) => Array<MetricExploreDataPoint>;
+export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], compareMetricRows: ResultRow[], comparison: MetricExplorerComparisonType) => Array<MetricExploreDataPoint>;
 /**
  * Get the date range for a given time interval, based on the current date and the time interval
  * Time grain Year: -> past 5 years (i.e. 5 completed years + this uncompleted year)

package/dist/utils/metricsExplorer.js

@@ -7,6 +7,7 @@ const lodash_1 = require("lodash");
 const uuid_1 = require("uuid");
 const conditionalRule_1 = require("../types/conditionalRule");
 const field_1 = require("../types/field");
+const metricsExplorer_1 = require("../types/metricsExplorer");
 const timeFrames_1 = require("../types/timeFrames");
 const assertUnreachable_1 = tslib_1.__importDefault(require("./assertUnreachable"));
 const item_1 = require("./item");
@@ -106,22 +107,33 @@ const getMetricExplorerDataPoints = (dimension, metric, metricRows) => {
     }));
 };
 exports.getMetricExplorerDataPoints = getMetricExplorerDataPoints;
-const getMetricExplorerDataPointsWithCompare = (dimension, metric, metricRows, compareMetricRows, offsetFunction = exports.oneYearForward) => {
+const getMetricExplorerDataPointsWithCompare = (dimension, metric, metricRows, compareMetricRows, comparison) => {
+    if (comparison.type === metricsExplorer_1.MetricExplorerComparison.NONE) {
+        throw new Error('Comparison type is required');
+    }
     const dimensionId = (0, item_1.getItemId)(dimension);
     const metricId = (0, item_1.getItemId)(metric);
     const mapDateField = (row) => new Date(String(row[dimensionId].value.raw)).toString();
     const groupByMetricRows = (0, lodash_1.groupBy)(metricRows, (row) => mapDateField(row));
     const groupByCompareMetricRows = (0, lodash_1.groupBy)(compareMetricRows, (row) => mapDateField(row));
-    const offsetGroupByCompareMetricRows = (0, lodash_1.mapKeys)(groupByCompareMetricRows, (_, date) => offsetFunction(new Date(date)).toString());
+    const offsetGroupByCompareMetricRows = (0, lodash_1.mapKeys)(groupByCompareMetricRows, (_, date) => comparison.type === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD
+        ? (0, exports.oneYearForward)(new Date(date)).toString()
+        : date);
     const dates = new Set([
         ...Object.keys(groupByMetricRows),
         ...Object.keys(offsetGroupByCompareMetricRows),
     ]);
+    const compareMetricId = comparison.type === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD
+        ? metricId
+        : (0, item_1.getItemId)({
+            table: comparison.metricTable,
+            name: comparison.metricName,
+        });
     return Array.from(dates).map((date) => ({
         date: new Date(date),
         metric: groupByMetricRows[date]?.[0]?.[metricId]?.value.raw ?? null,
-        compareMetric: offsetGroupByCompareMetricRows[date]?.[0]?.[metricId]?.value.raw ??
-            null,
+        compareMetric: offsetGroupByCompareMetricRows[date]?.[0]?.[compareMetricId]?.value
+            .raw ?? null,
     }));
 };
 exports.getMetricExplorerDataPointsWithCompare = getMetricExplorerDataPointsWithCompare;

package/package.json

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