@lightdash/common 0.1401.0 → 0.1403.0

package/dist/types/catalog.d.ts

@@ -146,4 +146,8 @@ export type ChartUsageIn = CatalogFieldWhere & {
     chartUsage: number;
 };
 export declare const indexCatalogJob = "indexCatalog";
+export type ApiMetricsWithAssociatedTimeDimensionResponse = {
+    status: 'ok';
+    results: MetricWithAssociatedTimeDimension[];
+};
 export {};

package/dist/types/metricsExplorer.d.ts

@@ -24,6 +24,7 @@ export type MetricExploreDataPoint = {
 };
 export type MetricsExplorerQueryResults = {
     metric: MetricWithAssociatedTimeDimension;
+    comparisonMetric: MetricWithAssociatedTimeDimension | undefined;
     rows: ResultRow[];
     comparisonRows: ResultRow[] | undefined;
     fields: ItemsMap;

package/dist/utils/metricsExplorer.d.ts

@@ -9,13 +9,15 @@ 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;
+type UnimplementedTimeframe = Exclude<TimeFrames, ImpelemntedTimeframe>;
+export declare const assertUnimplementedTimeframe: (timeframe: UnimplementedTimeframe) => never;
 export declare const getFieldIdForDateDimension: (fieldId: string, timeframe: TimeFrames) => string;
 export declare const oneYearBack: (date: Date) => Date;
 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[], comparison: MetricExplorerComparisonType) => Array<MetricExploreDataPoint>;
+export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: 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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAvailableTimeDimensionsFromTables = exports.getDefaultTimeDimension = exports.getFirstAvailableTimeDimension = exports.DEFAULT_METRICS_EXPLORER_TIME_INTERVAL = exports.getDefaultDateRangeFromInterval = exports.getMetricExplorerDataPointsWithCompare = exports.getMetricExplorerDataPoints = exports.getMetricExplorerDateRangeFilters = exports.getGrainForDateRange = exports.oneYearForward = exports.oneYearBack = exports.getFieldIdForDateDimension = void 0;
+exports.getAvailableTimeDimensionsFromTables = exports.getDefaultTimeDimension = exports.getFirstAvailableTimeDimension = exports.DEFAULT_METRICS_EXPLORER_TIME_INTERVAL = exports.getDefaultDateRangeFromInterval = exports.getMetricExplorerDataPointsWithCompare = exports.getMetricExplorerDataPoints = exports.getMetricExplorerDateRangeFilters = exports.getGrainForDateRange = exports.oneYearForward = exports.oneYearBack = exports.getFieldIdForDateDimension = exports.assertUnimplementedTimeframe = void 0;
 const tslib_1 = require("tslib");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const lodash_1 = require("lodash");
@@ -36,6 +36,7 @@ const assertUnimplementedTimeframe = (timeframe) => {
             return (0, assertUnreachable_1.default)(timeframe, `Unknown time interval: "${timeframe}"`);
     }
 };
+exports.assertUnimplementedTimeframe = assertUnimplementedTimeframe;
 const getFieldIdForDateDimension = (fieldId, timeframe) => {
     switch (timeframe) {
         case timeFrames_1.TimeFrames.DAY:
@@ -47,7 +48,7 @@ const getFieldIdForDateDimension = (fieldId, timeframe) => {
         case timeFrames_1.TimeFrames.YEAR:
             return `${fieldId}_year`;
         default:
-            return assertUnimplementedTimeframe(timeframe);
+            return (0, exports.assertUnimplementedTimeframe)(timeframe);
     }
 };
 exports.getFieldIdForDateDimension = getFieldIdForDateDimension;
@@ -99,7 +100,7 @@ exports.getMetricExplorerDateRangeFilters = getMetricExplorerDateRangeFilters;
 const getMetricExplorerDataPoints = (dimension, metric, metricRows) => {
     const dimensionId = (0, item_1.getItemId)(dimension);
     const metricId = (0, item_1.getItemId)(metric);
-    const groupByMetricRows = (0, lodash_1.groupBy)(metricRows, (row) => new Date(String(row[dimensionId].value.raw)).toString());
+    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: groupByMetricRows[date]?.[0]?.[metricId]?.value.raw ?? null,
@@ -107,17 +108,17 @@ const getMetricExplorerDataPoints = (dimension, metric, metricRows) => {
     }));
 };
 exports.getMetricExplorerDataPoints = getMetricExplorerDataPoints;
-const getMetricExplorerDataPointsWithCompare = (dimension, metric, metricRows, compareMetricRows, comparison) => {
+const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, 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 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 offsetGroupByCompareMetricRows = (0, lodash_1.mapKeys)(groupByCompareMetricRows, (_, date) => comparison.type === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD
-        ? (0, exports.oneYearForward)(new Date(date)).toString()
+        ? (0, exports.oneYearForward)(new Date(date)).toISOString()
         : date);
     const dates = new Set([
         ...Object.keys(groupByMetricRows),
@@ -170,7 +171,7 @@ const getDefaultDateRangeFromInterval = (timeInterval) => {
                 now.toDate(),
             ];
         default:
-            return assertUnimplementedTimeframe(timeInterval);
+            return (0, exports.assertUnimplementedTimeframe)(timeInterval);
     }
 };
 exports.getDefaultDateRangeFromInterval = getDefaultDateRangeFromInterval;

package/package.json

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