@lightdash/common 0.1386.4 → 0.1387.1

package/dist/types/coder.d.ts

@@ -1,8 +1,9 @@
-import type { SavedChart } from '..';
+import type { PromotionChanges, SavedChart } from '..';
 export declare const currentVersion = 1;
-export type ChartAsCode = Pick<SavedChart, 'name' | 'description' | 'tableName' | 'metricQuery' | 'chartConfig' | 'tableConfig' | 'slug' | 'dashboardUuid' | 'colorPalette' | 'updatedAt'> & {
+export type ChartAsCode = Pick<SavedChart, 'name' | 'description' | 'tableName' | 'metricQuery' | 'chartConfig' | 'tableConfig' | 'slug' | 'dashboardUuid' | 'updatedAt'> & {
     version: number;
     spaceSlug: string;
+    downloadedAt?: Date;
 };
 export type ApiChartAsCodeListResponse = {
     status: 'ok';
@@ -10,8 +11,5 @@ export type ApiChartAsCodeListResponse = {
 };
 export type ApiChartAsCodeUpsertResponse = {
     status: 'ok';
-    results: {
-        chart: ChartAsCode;
-        created: boolean;
-    };
+    results: PromotionChanges;
 };

package/dist/types/metricsExplorer.d.ts

@@ -5,6 +5,7 @@ export declare enum MetricExplorerComparison {
     PREVIOUS_PERIOD = "previous_period",
     DIFFERENT_METRIC = "different_metric"
 }
+export type MetricExplorerDateRange = [Date | null, Date | null];
 export type MetricExplorerComparisonType = {
     type: MetricExplorerComparison.NONE;
 } | {

package/dist/utils/metricsExplorer.d.ts

@@ -1,8 +1,10 @@
 import { ConditionalOperator } from '../types/conditionalRule';
 import { type DateFilterSettings, type FieldTarget, type FilterRule } from '../types/filter';
+import type { MetricExplorerDateRange } from '../types/metricsExplorer';
 import { TimeFrames } from '../types/timeFrames';
 type DateFilter = FilterRule<ConditionalOperator, FieldTarget, unknown, DateFilterSettings>;
-export declare const getMetricExplorerDimensionCurrentFilters: (exploreName: string, dimensionName: string, timeInterval: TimeFrames | undefined) => DateFilter[];
-export declare const getMetricExplorerDimensionPreviousFilters: (exploreName: string, dimensionName: string, timeInterval: TimeFrames | undefined) => DateFilter[];
 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 {};

package/dist/utils/metricsExplorer.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldIdForDateDimension = exports.getMetricExplorerDimensionPreviousFilters = exports.getMetricExplorerDimensionCurrentFilters = void 0;
+exports.getMetricExplorerDateRangeFilters = exports.getMetricExplorerDimensionPreviousFilters = exports.getMetricExplorerDefaultGrainFilters = exports.getFieldIdForDateDimension = void 0;
 const tslib_1 = require("tslib");
 const uuid_1 = require("uuid");
 const conditionalRule_1 = require("../types/conditionalRule");
@@ -33,14 +33,32 @@ const assertUnimplementedTimeframe = (timeframe) => {
             return (0, assertUnreachable_1.default)(timeframe, `Unknown time interval: "${timeframe}"`);
     }
 };
+const getFieldIdForDateDimension = (fieldId, timeframe) => {
+    switch (timeframe) {
+        case timeFrames_1.TimeFrames.DAY:
+            return `${fieldId}_day`;
+        case timeFrames_1.TimeFrames.WEEK:
+            return `${fieldId}_week`;
+        case timeFrames_1.TimeFrames.MONTH:
+            return `${fieldId}_month`;
+        case timeFrames_1.TimeFrames.YEAR:
+            return `${fieldId}_year`;
+        default:
+            return assertUnimplementedTimeframe(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 getMetricExplorerDimensionCurrentFilters = (exploreName, dimensionName, timeInterval) => {
+const getMetricExplorerDefaultGrainFilters = (exploreName, dimensionName, timeInterval) => {
+    const fieldWithGrain = timeInterval
+        ? (0, exports.getFieldIdForDateDimension)(dimensionName, timeInterval)
+        : dimensionName;
     const targetFieldId = (0, item_1.getItemId)({
         table: exploreName,
-        name: dimensionName,
+        name: fieldWithGrain,
     });
     if (!timeInterval) {
         throw new Error('Time interval is required to get relevant filter');
@@ -127,7 +145,7 @@ const getMetricExplorerDimensionCurrentFilters = (exploreName, dimensionName, ti
             return assertUnimplementedTimeframe(timeInterval);
     }
 };
-exports.getMetricExplorerDimensionCurrentFilters = getMetricExplorerDimensionCurrentFilters;
+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
@@ -242,18 +260,40 @@ const getMetricExplorerDimensionPreviousFilters = (exploreName, dimensionName, t
     }
 };
 exports.getMetricExplorerDimensionPreviousFilters = getMetricExplorerDimensionPreviousFilters;
-const getFieldIdForDateDimension = (fieldId, timeframe) => {
-    switch (timeframe) {
-        case timeFrames_1.TimeFrames.DAY:
-            return `${fieldId}_day`;
-        case timeFrames_1.TimeFrames.WEEK:
-            return `${fieldId}_week`;
-        case timeFrames_1.TimeFrames.MONTH:
-            return `${fieldId}_month`;
-        case timeFrames_1.TimeFrames.YEAR:
-            return `${fieldId}_year`;
-        default:
-            return assertUnimplementedTimeframe(timeframe);
+// 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 getGrainForDateRange = (dateRange) => {
+    const diff = dateRange[1].getTime() - dateRange[0].getTime();
+    const days = diff / (1000 * 60 * 60 * 24);
+    if (days <= 31) {
+        return timeFrames_1.TimeFrames.DAY;
+    }
+    if (days <= 7 * 12) {
+        return timeFrames_1.TimeFrames.WEEK;
     }
+    if (days <= 366) {
+        return timeFrames_1.TimeFrames.MONTH;
+    }
+    return timeFrames_1.TimeFrames.YEAR;
 };
-exports.getFieldIdForDateDimension = getFieldIdForDateDimension;
+const getMetricExplorerDateRangeFilters = (exploreName, dimensionName, [startDate, endDate]) => {
+    if (!startDate || !endDate) {
+        return [];
+    }
+    const defaultGrain = getGrainForDateRange([startDate, endDate]);
+    const targetFieldId = (0, item_1.getItemId)({
+        table: exploreName,
+        name: (0, exports.getFieldIdForDateDimension)(dimensionName, defaultGrain),
+    });
+    return [
+        {
+            id: (0, uuid_1.v4)(),
+            target: { fieldId: targetFieldId },
+            operator: conditionalRule_1.ConditionalOperator.IN_BETWEEN,
+            values: [startDate, endDate],
+        },
+    ];
+};
+exports.getMetricExplorerDateRangeFilters = getMetricExplorerDateRangeFilters;

package/package.json

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