@lightdash/common 0.1396.3 → 0.1397.0

package/dist/types/metricsExplorer.d.ts

@@ -5,7 +5,8 @@ export declare enum MetricExplorerComparison {
     PREVIOUS_PERIOD = "previous_period",
     DIFFERENT_METRIC = "different_metric"
 }
-export type MetricExplorerDateRange = [Date | null, Date | null];
+export type MetricExplorerPartialDateRange = [Date | null, Date | null];
+export type MetricExplorerDateRange = [Date, Date];
 export type MetricExplorerComparisonType = {
     type: MetricExplorerComparison.NONE;
 } | {
@@ -14,6 +15,11 @@ export type MetricExplorerComparisonType = {
     type: MetricExplorerComparison.DIFFERENT_METRIC;
     metricName: string;
 };
+export type MetricExploreDataPoint = {
+    date: Date;
+    metric: unknown;
+    compareMetric: unknown;
+};
 export type MetricsExplorerQueryResults = {
     rows: ResultRow[];
     comparisonRows: ResultRow[] | undefined;

package/dist/utils/metricsExplorer.d.ts

@@ -1,10 +1,27 @@
+import type { MetricWithAssociatedTimeDimension } from '../types/catalog';
 import { ConditionalOperator } from '../types/conditionalRule';
+import type { Dimension } from '../types/field';
 import { type DateFilterSettings, type FieldTarget, type FilterRule } from '../types/filter';
-import type { MetricExplorerDateRange } from '../types/metricsExplorer';
+import type { MetricExploreDataPoint, MetricExplorerDateRange } from '../types/metricsExplorer';
+import type { ResultRow } from '../types/results';
 import { TimeFrames } from '../types/timeFrames';
 type DateFilter = FilterRule<ConditionalOperator, FieldTarget, unknown, DateFilterSettings>;
+type ImpelemntedTimeframe = TimeFrames.DAY | TimeFrames.WEEK | TimeFrames.MONTH | TimeFrames.YEAR;
 export declare const getFieldIdForDateDimension: (fieldId: string, timeframe: TimeFrames) => string;
-export declare const getMetricExplorerDefaultGrainFilters: (exploreName: string, dimensionName: string, timeInterval: TimeFrames | undefined) => DateFilter[];
-export declare const getMetricExplorerDimensionPreviousFilters: (exploreName: string, dimensionName: string, timeInterval: TimeFrames | undefined) => DateFilter[];
-export declare const getMetricExplorerDateRangeFilters: (exploreName: string, dimensionName: string, [startDate, endDate]: MetricExplorerDateRange) => DateFilter[];
+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[], offsetFunction?: (date: Date) => Date) => 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)
+ * Time grain Month -> past 12 months (i.e. 12 completed months + this uncompleted month)
+ * Time grain Week -> past 12 weeks (i.e. 12 completed weeks + this uncompleted week)
+ * Time grain Day -> past 30 days (i.e. 30 completed days + this uncompleted day)
+ * @param timeInterval - The time interval
+ * @returns The date range
+ */
+export declare const getDefaultDateRangeFromInterval: (timeInterval: TimeFrames) => MetricExplorerDateRange;
 export {};

package/dist/utils/metricsExplorer.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMetricExplorerDateRangeFilters = exports.getMetricExplorerDimensionPreviousFilters = exports.getMetricExplorerDefaultGrainFilters = exports.getFieldIdForDateDimension = void 0;
+exports.getDefaultDateRangeFromInterval = exports.getMetricExplorerDataPointsWithCompare = exports.getMetricExplorerDataPoints = exports.getMetricExplorerDateRangeFilters = exports.getGrainForDateRange = exports.oneYearForward = exports.oneYearBack = exports.getFieldIdForDateDimension = void 0;
 const tslib_1 = require("tslib");
+const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+const lodash_1 = require("lodash");
 const uuid_1 = require("uuid");
 const conditionalRule_1 = require("../types/conditionalRule");
-const filter_1 = require("../types/filter");
 const timeFrames_1 = require("../types/timeFrames");
 const assertUnreachable_1 = tslib_1.__importDefault(require("./assertUnreachable"));
 const item_1 = require("./item");
@@ -48,241 +49,37 @@ const getFieldIdForDateDimension = (fieldId, timeframe) => {
     }
 };
 exports.getFieldIdForDateDimension = getFieldIdForDateDimension;
-// Time grain Year: -> past 5 years (i.e. 5 completed years + this uncompleted year)
-// Time grain Month -> past 12 months (i.e. 12 completed months + this uncompleted month)
-// Time grain Week -> past 12 weeks (i.e. 12 completed weeks + this uncompleted week)
-// Time grain Day -> past 30 days (i.e. 30 completed days + this uncompleted day)
-const getMetricExplorerDefaultGrainFilters = (exploreName, dimensionName, timeInterval) => {
-    const fieldWithGrain = timeInterval
-        ? (0, exports.getFieldIdForDateDimension)(dimensionName, timeInterval)
-        : dimensionName;
-    const targetFieldId = (0, item_1.getItemId)({
-        table: exploreName,
-        name: fieldWithGrain,
-    });
-    if (!timeInterval) {
-        throw new Error('Time interval is required to get relevant filter');
-    }
-    switch (timeInterval) {
-        case timeFrames_1.TimeFrames.DAY:
-            return [
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_PAST,
-                    values: [29],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.days,
-                        completed: true,
-                    },
-                },
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_CURRENT,
-                    values: [],
-                    settings: { unitOfTime: filter_1.UnitOfTime.days },
-                },
-            ];
-        case timeFrames_1.TimeFrames.WEEK:
-            return [
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_PAST,
-                    values: [11],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.weeks,
-                        completed: true,
-                    },
-                },
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_CURRENT,
-                    values: [],
-                    settings: { unitOfTime: filter_1.UnitOfTime.weeks },
-                },
-            ];
-        case timeFrames_1.TimeFrames.MONTH:
-            return [
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_PAST,
-                    values: [11],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.months,
-                        completed: true,
-                    },
-                },
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_CURRENT,
-                    values: [],
-                    settings: { unitOfTime: filter_1.UnitOfTime.months },
-                },
-            ];
-        case timeFrames_1.TimeFrames.YEAR:
-            return [
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_PAST,
-                    values: [4],
-                    settings: { unitOfTime: filter_1.UnitOfTime.years, completed: true },
-                },
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_CURRENT,
-                    values: [],
-                    settings: { unitOfTime: filter_1.UnitOfTime.years },
-                },
-            ];
-        default:
-            return assertUnimplementedTimeframe(timeInterval);
-    }
-};
-exports.getMetricExplorerDefaultGrainFilters = getMetricExplorerDefaultGrainFilters;
-// Time grain Year: -> 10 years ago - 5 years ago
-// Time grain Month -> 24 months ago - 12 months ago
-// Time grain Week -> 24 weeks ago - 12 weeks ago
-// Time grain Day -> 60 days ago - 30 days ago
-const getMetricExplorerDimensionPreviousFilters = (exploreName, dimensionName, timeInterval) => {
-    const targetFieldId = (0, item_1.getItemId)({
-        table: exploreName,
-        name: dimensionName,
-    });
-    if (!timeInterval) {
-        throw new Error('Time interval is required to get relevant filter');
-    }
-    switch (timeInterval) {
-        case timeFrames_1.TimeFrames.DAY:
-            // 60 days ago - 30 days ago
-            return [
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_PAST,
-                    values: [60],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.days,
-                        completed: true,
-                    },
-                },
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.NOT_IN_THE_PAST,
-                    values: [30],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.days,
-                        completed: true,
-                    },
-                },
-            ];
-        case timeFrames_1.TimeFrames.WEEK:
-            // 24 weeks ago - 12 weeks ago
-            return [
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_PAST,
-                    values: [24],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.weeks,
-                        completed: true,
-                    },
-                },
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.NOT_IN_THE_PAST,
-                    values: [12],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.weeks,
-                        completed: true,
-                    },
-                },
-            ];
-        case timeFrames_1.TimeFrames.MONTH:
-            // 24 months ago - 12 months ago
-            return [
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_PAST,
-                    values: [24],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.months,
-                        completed: true,
-                    },
-                },
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.NOT_IN_THE_PAST,
-                    values: [12],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.months,
-                        completed: true,
-                    },
-                },
-            ];
-        case timeFrames_1.TimeFrames.YEAR:
-            // 10 years ago - 5 years ago
-            return [
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.IN_THE_PAST,
-                    values: [10],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.years,
-                        completed: true,
-                    },
-                },
-                {
-                    id: (0, uuid_1.v4)(),
-                    target: { fieldId: targetFieldId },
-                    operator: conditionalRule_1.ConditionalOperator.NOT_IN_THE_PAST,
-                    values: [5],
-                    settings: {
-                        unitOfTime: filter_1.UnitOfTime.years,
-                        completed: true,
-                    },
-                },
-            ];
-        default:
-            return assertUnimplementedTimeframe(timeInterval);
-    }
-};
-exports.getMetricExplorerDimensionPreviousFilters = getMetricExplorerDimensionPreviousFilters;
-// Time grain Year: -> past 5 years (i.e. 5 completed years + this uncompleted year)
-// Time grain Month -> past 12 months (i.e. 12 completed months + this uncompleted month)
-// Time grain Week -> past 12 weeks (i.e. 12 completed weeks + this uncompleted week)
-// Time grain Day -> past 30 days (i.e. 30 completed days + this uncompleted day)
+const oneYearBack = (date) => (0, dayjs_1.default)(date)
+    .set('year', (0, dayjs_1.default)(date).get('year') - 1)
+    .toDate();
+exports.oneYearBack = oneYearBack;
+const oneYearForward = (date) => (0, dayjs_1.default)(date)
+    .set('year', (0, dayjs_1.default)(date).get('year') + 1)
+    .toDate();
+exports.oneYearForward = oneYearForward;
+// TODO: refine the time grain for each time frame
+//   Time grain Year: -> past 5 years (i.e. 5 completed years + this uncompleted year)
+//   Time grain Month -> past 12 months (i.e. 12 completed months + this uncompleted month)
+//   Time grain Week -> past 12 weeks (i.e. 12 completed weeks + this uncompleted week)
+//   Time grain Day -> past 30 days (i.e. 30 completed days + this uncompleted day)
+// above sample is taken from the spec but the implementation is different for practical reasons for visualization
 const getGrainForDateRange = (dateRange) => {
     const diff = dateRange[1].getTime() - dateRange[0].getTime();
     const days = diff / (1000 * 60 * 60 * 24);
-    if (days <= 31) {
+    if (days <= 31 * 3) {
         return timeFrames_1.TimeFrames.DAY;
     }
     if (days <= 7 * 12) {
         return timeFrames_1.TimeFrames.WEEK;
     }
-    if (days <= 366) {
+    if (days <= 31 * 12) {
         return timeFrames_1.TimeFrames.MONTH;
     }
     return timeFrames_1.TimeFrames.YEAR;
 };
-const getMetricExplorerDateRangeFilters = (exploreName, dimensionName, [startDate, endDate]) => {
-    if (!startDate || !endDate) {
-        return [];
-    }
-    const defaultGrain = getGrainForDateRange([startDate, endDate]);
+exports.getGrainForDateRange = getGrainForDateRange;
+const getMetricExplorerDateRangeFilters = (exploreName, dimensionName, dateRange) => {
+    const defaultGrain = (0, exports.getGrainForDateRange)(dateRange);
     const targetFieldId = (0, item_1.getItemId)({
         table: exploreName,
         name: (0, exports.getFieldIdForDateDimension)(dimensionName, defaultGrain),
@@ -292,8 +89,75 @@ const getMetricExplorerDateRangeFilters = (exploreName, dimensionName, [startDat
             id: (0, uuid_1.v4)(),
             target: { fieldId: targetFieldId },
             operator: conditionalRule_1.ConditionalOperator.IN_BETWEEN,
-            values: [startDate, endDate],
+            values: dateRange,
         },
     ];
 };
 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());
+    return Object.keys(groupByMetricRows).map((date) => ({
+        date: new Date(date),
+        metric: groupByMetricRows[date]?.[0]?.[metricId]?.value.raw ?? null,
+        compareMetric: null,
+    }));
+};
+exports.getMetricExplorerDataPoints = getMetricExplorerDataPoints;
+const getMetricExplorerDataPointsWithCompare = (dimension, metric, metricRows, compareMetricRows, offsetFunction = exports.oneYearForward) => {
+    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 dates = new Set([
+        ...Object.keys(groupByMetricRows),
+        ...Object.keys(offsetGroupByCompareMetricRows),
+    ]);
+    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,
+    }));
+};
+exports.getMetricExplorerDataPointsWithCompare = getMetricExplorerDataPointsWithCompare;
+/**
+ * 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)
+ * Time grain Month -> past 12 months (i.e. 12 completed months + this uncompleted month)
+ * Time grain Week -> past 12 weeks (i.e. 12 completed weeks + this uncompleted week)
+ * Time grain Day -> past 30 days (i.e. 30 completed days + this uncompleted day)
+ * @param timeInterval - The time interval
+ * @returns The date range
+ */
+const getDefaultDateRangeFromInterval = (timeInterval) => {
+    const now = (0, dayjs_1.default)();
+    switch (timeInterval) {
+        case timeFrames_1.TimeFrames.DAY:
+            return [
+                now.subtract(29, 'day').startOf('day').toDate(),
+                now.toDate(),
+            ];
+        case timeFrames_1.TimeFrames.WEEK:
+            return [
+                now.subtract(11, 'week').startOf('week').toDate(),
+                now.toDate(),
+            ];
+        case timeFrames_1.TimeFrames.MONTH:
+            return [
+                now.subtract(11, 'month').startOf('month').toDate(),
+                now.toDate(),
+            ];
+        case timeFrames_1.TimeFrames.YEAR:
+            return [
+                now.subtract(4, 'year').startOf('year').toDate(),
+                now.toDate(),
+            ];
+        default:
+            return assertUnimplementedTimeframe(timeInterval);
+    }
+};
+exports.getDefaultDateRangeFromInterval = getDefaultDateRangeFromInterval;

package/package.json

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