@lightdash/common 0.1411.2 → 0.1412.0

package/dist/types/catalog.d.ts

@@ -176,4 +176,8 @@ export type ApiMetricsWithAssociatedTimeDimensionResponse = {
     status: 'ok';
     results: MetricWithAssociatedTimeDimension[];
 };
+export type ApiSegmentDimensionsResponse = {
+    status: 'ok';
+    results: CompiledDimension[];
+};
 export {};

package/dist/types/metricsExplorer.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { type MetricWithAssociatedTimeDimension } from './catalog';
-import type { ItemsMap } from './field';
+import type { Dimension, ItemsMap } from './field';
 import type { ResultValue } from './results';
 export declare enum MetricExplorerComparison {
     NONE = "none",
@@ -9,12 +9,13 @@ export declare enum MetricExplorerComparison {
 }
 export type MetricExplorerPartialDateRange = [Date | null, Date | null];
 export type MetricExplorerDateRange = [Date, Date];
-export type MetricExplorerComparisonType = {
-    type: MetricExplorerComparison.NONE;
+export type MetricExplorerQuery = {
+    comparison: MetricExplorerComparison.NONE;
+    segmentDimension: string | null;
 } | {
-    type: MetricExplorerComparison.PREVIOUS_PERIOD;
+    comparison: MetricExplorerComparison.PREVIOUS_PERIOD;
 } | {
-    type: MetricExplorerComparison.DIFFERENT_METRIC;
+    comparison: MetricExplorerComparison.DIFFERENT_METRIC;
     metric: {
         label: string;
         table: string;
@@ -23,6 +24,7 @@ export type MetricExplorerComparisonType = {
 };
 export declare const metricExploreDataPointWithDateValueSchema: z.ZodObject<z.objectUtil.extendShape<{
     date: z.ZodDate;
+    segment: z.ZodNullable<z.ZodString>;
     metric: z.ZodObject<{
         value: z.ZodNullable<z.ZodNumber>;
         label: z.ZodNullable<z.ZodString>;
@@ -51,6 +53,7 @@ export declare const metricExploreDataPointWithDateValueSchema: z.ZodObject<z.ob
         value: number | null;
     };
     date: Date;
+    segment: string | null;
     compareMetric: {
         label: string | null;
         value: number | null;
@@ -62,6 +65,7 @@ export declare const metricExploreDataPointWithDateValueSchema: z.ZodObject<z.ob
         value: number | null;
     };
     date: Date;
+    segment: string | null;
     compareMetric: {
         label: string | null;
         value: number | null;
@@ -70,6 +74,7 @@ export declare const metricExploreDataPointWithDateValueSchema: z.ZodObject<z.ob
 }>;
 export type MetricExploreDataPoint = {
     date: Date;
+    segment: string | null;
     metric: {
         value: number | null;
         label: string | null;
@@ -84,7 +89,8 @@ export type MetricExploreDataPointWithDateValue = MetricExploreDataPoint & {
 };
 export type MetricsExplorerQueryResults = {
     metric: MetricWithAssociatedTimeDimension;
-    compareMetric: MetricWithAssociatedTimeDimension | undefined;
+    compareMetric: MetricWithAssociatedTimeDimension | null;
+    segmentDimension: Dimension | null;
     fields: ItemsMap;
     results: MetricExploreDataPointWithDateValue[];
 };

package/dist/types/metricsExplorer.js

@@ -10,6 +10,7 @@ var MetricExplorerComparison;
 })(MetricExplorerComparison = exports.MetricExplorerComparison || (exports.MetricExplorerComparison = {}));
 const metricExploreDataPointSchema = zod_1.z.object({
     date: zod_1.z.date({ coerce: true }),
+    segment: zod_1.z.string().nullable(),
     metric: zod_1.z.object({
         value: zod_1.z.number().nullable(),
         label: zod_1.z.string().nullable(),

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, type MetricExplorerComparisonType, type MetricExplorerDateRange } from '../types/metricsExplorer';
+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>;
@@ -16,10 +16,12 @@ export declare const getDateCalcUtils: (timeFrame: TimeFrames) => {
     forward: (date: Date) => Date;
     back: (date: Date) => Date;
 };
+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: (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, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], compareMetricRows: ResultRow[], comparison: MetricExplorerComparisonType) => Array<MetricExploreDataPoint>;
+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>;
 /**
  * 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.getDefaultDateRangeForMetricTotal = exports.getDefaultDateRangeFromInterval = exports.getMetricExplorerDataPointsWithCompare = exports.getMetricExplorerDataPoints = exports.getMetricExplorerDateRangeFilters = exports.getGrainForDateRange = exports.getDateCalcUtils = exports.getFieldIdForDateDimension = exports.assertUnimplementedTimeframe = void 0;
+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;
 const tslib_1 = require("tslib");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const lodash_1 = require("lodash");
@@ -79,6 +79,12 @@ const getDateCalcUtils = (timeFrame) => {
     }
 };
 exports.getDateCalcUtils = getDateCalcUtils;
+exports.METRICS_EXPLORER_DATE_FORMAT = 'YYYY-MM-DD';
+const getDateRangeFromString = (dateRange) => [
+    (0, dayjs_1.default)(dateRange[0], exports.METRICS_EXPLORER_DATE_FORMAT).toDate(),
+    (0, dayjs_1.default)(dateRange[1], exports.METRICS_EXPLORER_DATE_FORMAT).toDate(),
+];
+exports.getDateRangeFromString = getDateRangeFromString;
 // 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)
@@ -100,18 +106,17 @@ const getGrainForDateRange = (dateRange) => {
     return timeFrames_1.TimeFrames.YEAR;
 };
 exports.getGrainForDateRange = getGrainForDateRange;
-const getMetricExplorerDateRangeFilters = (exploreName, dimensionName, dateRange) => {
-    const defaultGrain = (0, exports.getGrainForDateRange)(dateRange);
+const getMetricExplorerDateRangeFilters = (timeDimensionConfig, dateRange) => {
     const targetFieldId = (0, item_1.getItemId)({
-        table: exploreName,
-        name: (0, exports.getFieldIdForDateDimension)(dimensionName, defaultGrain),
+        table: timeDimensionConfig.table,
+        name: (0, exports.getFieldIdForDateDimension)(timeDimensionConfig.field, timeDimensionConfig.interval),
     });
     return [
         {
             id: (0, uuid_1.v4)(),
             target: { fieldId: targetFieldId },
             operator: conditionalRule_1.ConditionalOperator.IN_BETWEEN,
-            values: dateRange,
+            values: dateRange.map((date) => (0, dayjs_1.default)(date).format(exports.METRICS_EXPLORER_DATE_FORMAT)),
         },
     ];
 };
@@ -124,25 +129,38 @@ const parseMetricValue = (value) => {
     const parsed = Number(value);
     return Number.isNaN(parsed) ? null : parsed;
 };
-const getMetricExplorerDataPoints = (dimension, metric, metricRows) => {
+// 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) => {
+    if (value === undefined)
+        return null;
+    return String(value);
+};
+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.keys(groupByMetricRows).map((date) => ({
-        date: new Date(date),
-        metric: {
-            value: parseMetricValue(groupByMetricRows[date]?.[0]?.[metricId]?.value.raw),
-            label: metric.label ?? metric.name,
-        },
-        compareMetric: {
-            value: null,
-            label: null,
-        },
+    return Object.entries(groupByMetricRows).flatMap(([date, rows]) => rows.map((row) => {
+        const segmentValue = segmentDimensionId
+            ? parseDimensionValue(row[segmentDimensionId]?.value.raw)
+            : null;
+        return {
+            date: new Date(date),
+            segment: segmentValue,
+            metric: {
+                value: parseMetricValue(row[metricId]?.value.raw),
+                label: segmentValue ?? metric.label ?? metric.name,
+            },
+            compareMetric: {
+                value: null,
+                label: null,
+            },
+        };
     }));
 };
 exports.getMetricExplorerDataPoints = getMetricExplorerDataPoints;
-const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, metric, metricRows, compareMetricRows, comparison) => {
-    if (comparison.type === metricsExplorer_1.MetricExplorerComparison.NONE) {
+const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, metric, metricRows, compareMetricRows, query) => {
+    if (query.comparison === metricsExplorer_1.MetricExplorerComparison.NONE) {
         throw new Error('Comparison type is required');
     }
     const metricId = (0, item_1.getItemId)(metric);
@@ -150,7 +168,7 @@ const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, met
     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
+    const offsetGroupByCompareMetricRows = (0, lodash_1.mapKeys)(groupByCompareMetricRows, (_, date) => query.comparison === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD
         ? (0, exports.getDateCalcUtils)(timeFrames_1.TimeFrames.YEAR)
             .forward(new Date(date))
             .toISOString()
@@ -159,22 +177,22 @@ const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, met
         ...Object.keys(groupByMetricRows),
         ...Object.keys(offsetGroupByCompareMetricRows),
     ]);
-    const compareMetricId = comparison.type === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD
+    const compareMetricId = query.comparison === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD
         ? metricId
         : (0, item_1.getItemId)({
-            table: comparison.metric.table,
-            name: comparison.metric.name,
+            table: query.metric.table,
+            name: query.metric.name,
         });
     let comparisonMetricLabel = null;
-    if (comparison.type === metricsExplorer_1.MetricExplorerComparison.DIFFERENT_METRIC) {
-        comparisonMetricLabel =
-            comparison.metric.label ?? comparison.metric.name;
+    if (query.comparison === metricsExplorer_1.MetricExplorerComparison.DIFFERENT_METRIC) {
+        comparisonMetricLabel = query.metric.label ?? query.metric.name;
     }
-    else if (comparison.type === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD) {
+    else if (query.comparison === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD) {
         comparisonMetricLabel = 'Previous Period';
     }
     return Array.from(dates).map((date) => ({
         date: new Date(date),
+        segment: null,
         metric: {
             value: parseMetricValue(groupByMetricRows[date]?.[0]?.[metricId]?.value.raw),
             label: metric.label ?? metric.name,

package/package.json

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