@lightdash/common 0.1412.0 → 0.1413.0

package/dist/types/metricsExplorer.d.ts

@@ -93,6 +93,7 @@ export type MetricsExplorerQueryResults = {
     segmentDimension: Dimension | null;
     fields: ItemsMap;
     results: MetricExploreDataPointWithDateValue[];
+    hasFilteredSeries: boolean;
 };
 export type ApiMetricsExplorerQueryResults = {
     status: 'ok';

package/dist/utils/metricsExplorer.d.ts

@@ -20,8 +20,14 @@ 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 getMetricExplorerDataPoints: (dimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], segmentDimensionId: string | null) => Array<MetricExploreDataPoint>;
-export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], compareMetricRows: ResultRow[], query: MetricExplorerQuery) => Array<MetricExploreDataPoint>;
+export declare const MAX_SEGMENT_DIMENSION_UNIQUE_VALUES = 10;
+export declare const getMetricExplorerDataPoints: (dimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], segmentDimensionId: string | null) => {
+    dataPoints: Array<MetricExploreDataPoint>;
+    isSegmentDimensionFiltered: boolean;
+};
+export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], compareMetricRows: ResultRow[], query: MetricExplorerQuery) => {
+    dataPoints: 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)
@@ -46,4 +52,6 @@ export declare const getDefaultTimeDimension: (metric: CompiledMetric, table?: C
 export declare const getAvailableTimeDimensionsFromTables: (tables: Record<string, CompiledTable>) => (CompiledDimension & {
     type: DimensionType.DATE | DimensionType.TIMESTAMP;
 })[];
+export declare const getAvailableSegmentDimensions: (dimensions: Dimension[]) => CompiledDimension[];
+export declare const getAvailableCompareMetrics: (metrics: MetricWithAssociatedTimeDimension[]) => MetricWithAssociatedTimeDimension[];
 export {};

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.getDefaultDateRangeForMetricTotal = exports.getDefaultDateRangeFromInterval = exports.getMetricExplorerDataPointsWithCompare = exports.getMetricExplorerDataPoints = 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.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;
 const tslib_1 = require("tslib");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const lodash_1 = require("lodash");
@@ -136,11 +136,22 @@ const parseDimensionValue = (value) => {
         return null;
     return String(value);
 };
+exports.MAX_SEGMENT_DIMENSION_UNIQUE_VALUES = 10;
 const getMetricExplorerDataPoints = (dimension, metric, metricRows, segmentDimensionId) => {
     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)).toISOString());
-    return Object.entries(groupByMetricRows).flatMap(([date, rows]) => rows.map((row) => {
+    let filteredMetricRows = metricRows;
+    let isSegmentDimensionFiltered = false;
+    if (segmentDimensionId) {
+        const countUniqueValues = new Set(metricRows.map((row) => row[segmentDimensionId]?.value.raw)).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 groupByMetricRows = (0, lodash_1.groupBy)(filteredMetricRows, (row) => new Date(String(row[dimensionId].value.raw)).toISOString());
+    const dataPoints = Object.entries(groupByMetricRows).flatMap(([date, rows]) => rows.map((row) => {
         const segmentValue = segmentDimensionId
             ? parseDimensionValue(row[segmentDimensionId]?.value.raw)
             : null;
@@ -157,6 +168,10 @@ const getMetricExplorerDataPoints = (dimension, metric, metricRows, segmentDimen
             },
         };
     }));
+    return {
+        dataPoints,
+        isSegmentDimensionFiltered,
+    };
 };
 exports.getMetricExplorerDataPoints = getMetricExplorerDataPoints;
 const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, metric, metricRows, compareMetricRows, query) => {
@@ -190,7 +205,7 @@ const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, met
     else if (query.comparison === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD) {
         comparisonMetricLabel = 'Previous Period';
     }
-    return Array.from(dates).map((date) => ({
+    const dataPoints = Array.from(dates).map((date) => ({
         date: new Date(date),
         segment: null,
         metric: {
@@ -203,6 +218,7 @@ const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, met
             label: comparisonMetricLabel,
         },
     }));
+    return { dataPoints };
 };
 exports.getMetricExplorerDataPointsWithCompare = getMetricExplorerDataPointsWithCompare;
 /**
@@ -305,3 +321,16 @@ const getAvailableTimeDimensionsFromTables = (tables) => Object.values(tables).f
     !!dim.isIntervalBase &&
     !dim.hidden));
 exports.getAvailableTimeDimensionsFromTables = getAvailableTimeDimensionsFromTables;
+const getAvailableSegmentDimensions = (dimensions) => dimensions
+    .filter((d) => !!d)
+    .filter((d) => d.type !== field_1.DimensionType.DATE &&
+    d.type !== field_1.DimensionType.TIMESTAMP &&
+    d.type !== field_1.DimensionType.NUMBER);
+exports.getAvailableSegmentDimensions = getAvailableSegmentDimensions;
+const getAvailableCompareMetrics = (metrics) => metrics
+    .filter((metric) => !!metric.timeDimension)
+    .filter((metric) => metric.type !== field_1.MetricType.STRING &&
+    metric.type !== field_1.MetricType.BOOLEAN &&
+    metric.type !== field_1.MetricType.DATE &&
+    metric.type !== field_1.MetricType.TIMESTAMP);
+exports.getAvailableCompareMetrics = getAvailableCompareMetrics;

package/package.json

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