@lightdash/common 0.1418.2 → 0.1419.1

package/dist/index.d.ts

@@ -37,7 +37,7 @@ import { type LightdashUser, type LoginOptions, type UserAllowedOrganization } f
 import { type UserWarehouseCredentials } from './types/userWarehouseCredentials';
 import { type ValidationResponse } from './types/validation';
 import { type ApiCatalogAnalyticsResults, type ApiCatalogMetadataResults, type ApiGetMetricsTree, type ApiMetricsCatalog } from './types/catalog';
-import { type ApiChartAsCodeListResponse, type ApiChartAsCodeUpsertResponse } from './types/coder';
+import { type ApiChartAsCodeListResponse, type ApiChartAsCodeUpsertResponse, type ApiDashboardAsCodeListResponse } from './types/coder';
 import { type ApiChartContentResponse, type ApiContentResponse } from './types/content';
 import type { ApiGroupListResponse } from './types/groups';
 import type { ApiMetricsExplorerQueryResults, ApiMetricsExplorerTotalResults } from './types/metricsExplorer';
@@ -382,7 +382,7 @@ export type ApiAiGetDashboardSummaryResponse = {
     status: 'ok';
     results: DashboardSummary;
 };
-type ApiResults = ApiQueryResults | ApiSqlQueryResults | ApiCompiledQueryResults | ApiExploresResults | ApiExploreResults | ApiStatusResults | ApiRefreshResults | ApiHealthResults | Organization | LightdashUser | LoginOptions | SavedChart | SavedChart[] | Space[] | InviteLink | OrganizationProject[] | Project | WarehouseCredentials | OrganizationMemberProfile[] | ProjectCatalog | TablesConfiguration | Dashboard | DashboardBasicDetails[] | OnboardingStatus | Dashboard[] | DeleteOpenIdentity | ApiFlashResults | Record<OpenIdIdentitySummary['issuerType'], OpenIdIdentitySummary[]> | FilterableField[] | DashboardAvailableFilters | ProjectSavedChartStatus | null | Array<unknown> | ApiJobStartedResults | ApiCreateUserTokenResults | CreatePersonalAccessToken | PersonalAccessToken | ProjectMemberProfile[] | ProjectGroupAccess | SearchResults | Space | ShareUrl | SlackSettings | ApiSlackChannelsResponse['results'] | UserActivity | SchedulerAndTargets | SchedulerAndTargets[] | FieldValueSearchResult | ApiDownloadCsv | AllowedEmailDomains | UpdateAllowedEmailDomains | UserAllowedOrganization[] | EmailStatusExpiring | ApiScheduledDownloadCsv | PinnedItems | ViewStatistics | SchedulerWithLogs | ValidationResponse[] | ChartHistory | ChartVersion | Array<GitRepo> | PullRequestCreated | GitIntegrationConfiguration | UserWarehouseCredentials | ApiJobStatusResponse['results'] | ApiJobScheduledResponse['results'] | ApiSshKeyPairResponse['results'] | MostPopularAndRecentlyUpdated | ApiCalculateTotalResponse['results'] | Record<string, DbtExposure> | ApiCreateComment['results'] | ApiGetComments['results'] | ApiDeleteComment | ApiSuccessEmpty | ApiCreateProjectResults | ApiAiDashboardSummaryResponse['results'] | ApiAiGetDashboardSummaryResponse['results'] | ApiCatalogMetadataResults | ApiCatalogAnalyticsResults | ApiPromotionChangesResponse['results'] | ApiWarehouseTableFields['results'] | ApiTogglePinnedItem['results'] | ApiOrganizationMemberProfiles['results'] | ApiSqlChart['results'] | ApiCreateSqlChart['results'] | ApiUpdateSqlChart['results'] | ApiContentResponse['results'] | ApiChartContentResponse['results'] | ApiSqlRunnerJobStatusResponse['results'] | ApiSemanticLayerClientInfo['results'] | ApiSemanticViewerChartCreate['results'] | ApiSemanticViewerChartGet['results'] | ApiSemanticViewerChartUpdate['results'] | ApiCreateVirtualView['results'] | ApiGithubDbtWritePreview['results'] | ApiMetricsCatalog['results'] | ApiMetricsExplorerQueryResults['results'] | ApiGroupListResponse['results'] | ApiCreateTagResponse['results'] | ApiChartAsCodeListResponse['results'] | ApiChartAsCodeUpsertResponse['results'] | ApiGetMetricsTree['results'] | ApiMetricsExplorerTotalResults['results'];
+type ApiResults = ApiQueryResults | ApiSqlQueryResults | ApiCompiledQueryResults | ApiExploresResults | ApiExploreResults | ApiStatusResults | ApiRefreshResults | ApiHealthResults | Organization | LightdashUser | LoginOptions | SavedChart | SavedChart[] | Space[] | InviteLink | OrganizationProject[] | Project | WarehouseCredentials | OrganizationMemberProfile[] | ProjectCatalog | TablesConfiguration | Dashboard | DashboardBasicDetails[] | OnboardingStatus | Dashboard[] | DeleteOpenIdentity | ApiFlashResults | Record<OpenIdIdentitySummary['issuerType'], OpenIdIdentitySummary[]> | FilterableField[] | DashboardAvailableFilters | ProjectSavedChartStatus | null | Array<unknown> | ApiJobStartedResults | ApiCreateUserTokenResults | CreatePersonalAccessToken | PersonalAccessToken | ProjectMemberProfile[] | ProjectGroupAccess | SearchResults | Space | ShareUrl | SlackSettings | ApiSlackChannelsResponse['results'] | UserActivity | SchedulerAndTargets | SchedulerAndTargets[] | FieldValueSearchResult | ApiDownloadCsv | AllowedEmailDomains | UpdateAllowedEmailDomains | UserAllowedOrganization[] | EmailStatusExpiring | ApiScheduledDownloadCsv | PinnedItems | ViewStatistics | SchedulerWithLogs | ValidationResponse[] | ChartHistory | ChartVersion | Array<GitRepo> | PullRequestCreated | GitIntegrationConfiguration | UserWarehouseCredentials | ApiJobStatusResponse['results'] | ApiJobScheduledResponse['results'] | ApiSshKeyPairResponse['results'] | MostPopularAndRecentlyUpdated | ApiCalculateTotalResponse['results'] | Record<string, DbtExposure> | ApiCreateComment['results'] | ApiGetComments['results'] | ApiDeleteComment | ApiSuccessEmpty | ApiCreateProjectResults | ApiAiDashboardSummaryResponse['results'] | ApiAiGetDashboardSummaryResponse['results'] | ApiCatalogMetadataResults | ApiCatalogAnalyticsResults | ApiPromotionChangesResponse['results'] | ApiWarehouseTableFields['results'] | ApiTogglePinnedItem['results'] | ApiOrganizationMemberProfiles['results'] | ApiSqlChart['results'] | ApiCreateSqlChart['results'] | ApiUpdateSqlChart['results'] | ApiContentResponse['results'] | ApiChartContentResponse['results'] | ApiSqlRunnerJobStatusResponse['results'] | ApiSemanticLayerClientInfo['results'] | ApiSemanticViewerChartCreate['results'] | ApiSemanticViewerChartGet['results'] | ApiSemanticViewerChartUpdate['results'] | ApiCreateVirtualView['results'] | ApiGithubDbtWritePreview['results'] | ApiMetricsCatalog['results'] | ApiMetricsExplorerQueryResults['results'] | ApiGroupListResponse['results'] | ApiCreateTagResponse['results'] | ApiChartAsCodeListResponse['results'] | ApiDashboardAsCodeListResponse['results'] | ApiChartAsCodeUpsertResponse['results'] | ApiGetMetricsTree['results'] | ApiMetricsExplorerTotalResults['results'];
 export type ApiResponse<T extends ApiResults = ApiResults> = {
     status: 'ok';
     results: T;

package/dist/types/coder.d.ts

@@ -7,7 +7,10 @@ export type ChartAsCode = Pick<SavedChart, 'name' | 'description' | 'tableName'
 };
 export type ApiChartAsCodeListResponse = {
     status: 'ok';
-    results: ChartAsCode[];
+    results: {
+        charts: ChartAsCode[];
+        missingIds: string[];
+    };
 };
 export type ApiChartAsCodeUpsertResponse = {
     status: 'ok';
@@ -25,7 +28,10 @@ export type DashboardAsCode = Pick<Dashboard, 'name' | 'description' | 'updatedA
 };
 export type ApiDashboardAsCodeListResponse = {
     status: 'ok';
-    results: DashboardAsCode[];
+    results: {
+        dashboards: DashboardAsCode[];
+        missingIds: string[];
+    };
 };
 export type ApiDashboardAsCodeUpsertResponse = {
     status: 'ok';

package/dist/utils/metricsExplorer.d.ts

@@ -12,7 +12,7 @@ type ImpelemntedTimeframe = TimeFrames.DAY | TimeFrames.WEEK | TimeFrames.MONTH
 type UnimplementedTimeframe = Exclude<TimeFrames, ImpelemntedTimeframe>;
 export declare const assertUnimplementedTimeframe: (timeframe: UnimplementedTimeframe) => never;
 export declare const getFieldIdForDateDimension: (fieldId: string, timeframe: TimeFrames) => string;
-export declare const getDateCalcUtils: (timeFrame: TimeFrames) => {
+export declare const getDateCalcUtils: (timeFrame: TimeFrames, grain?: TimeFrames) => {
     forward: (date: Date) => Date;
     back: (date: Date) => Date;
 };
@@ -25,7 +25,7 @@ export declare const getMetricExplorerDataPoints: (dimension: Dimension, metric:
     dataPoints: Array<MetricExploreDataPoint>;
     isSegmentDimensionFiltered: boolean;
 };
-export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], compareMetricRows: ResultRow[], query: MetricExplorerQuery) => {
+export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimension, compareDimension: Dimension, metric: MetricWithAssociatedTimeDimension, metricRows: ResultRow[], compareMetricRows: ResultRow[], query: MetricExplorerQuery, timeFrame: TimeFrames) => {
     dataPoints: Array<MetricExploreDataPoint>;
 };
 /**

package/dist/utils/metricsExplorer.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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 isoWeek_1 = tslib_1.__importDefault(require("dayjs/plugin/isoWeek"));
+const weekOfYear_1 = tslib_1.__importDefault(require("dayjs/plugin/weekOfYear"));
 const lodash_1 = require("lodash");
 const uuid_1 = require("uuid");
 const conditionalRule_1 = require("../types/conditionalRule");
@@ -11,6 +13,8 @@ const metricsExplorer_1 = require("../types/metricsExplorer");
 const timeFrames_1 = require("../types/timeFrames");
 const assertUnreachable_1 = tslib_1.__importDefault(require("./assertUnreachable"));
 const item_1 = require("./item");
+dayjs_1.default.extend(isoWeek_1.default);
+dayjs_1.default.extend(weekOfYear_1.default);
 const assertUnimplementedTimeframe = (timeframe) => {
     switch (timeframe) {
         case timeFrames_1.TimeFrames.RAW:
@@ -52,28 +56,38 @@ const getFieldIdForDateDimension = (fieldId, timeframe) => {
     }
 };
 exports.getFieldIdForDateDimension = getFieldIdForDateDimension;
-const getDateCalcUtils = (timeFrame) => {
+const getDateCalcUtils = (timeFrame, grain) => {
     switch (timeFrame) {
-        case timeFrames_1.TimeFrames.DAY:
-            return {
-                forward: (date) => (0, dayjs_1.default)(date).add(1, 'day').toDate(),
-                back: (date) => (0, dayjs_1.default)(date).subtract(1, 'day').toDate(),
-            };
-        case timeFrames_1.TimeFrames.WEEK:
-            return {
-                forward: (date) => (0, dayjs_1.default)(date).add(1, 'week').toDate(),
-                back: (date) => (0, dayjs_1.default)(date).subtract(1, 'week').toDate(),
-            };
         case timeFrames_1.TimeFrames.MONTH:
+            if (grain)
+                throw new Error(`Timeframe "${grain}" is not supported yet for this timeframe "${timeFrame}"`);
             return {
                 forward: (date) => (0, dayjs_1.default)(date).add(1, 'month').toDate(),
                 back: (date) => (0, dayjs_1.default)(date).subtract(1, 'month').toDate(),
             };
         case timeFrames_1.TimeFrames.YEAR:
+            // Handle week shift for previous year comparison and subtract what the amount of weeks is in a year
+            if (grain === timeFrames_1.TimeFrames.WEEK) {
+                return {
+                    forward: (date) => (0, dayjs_1.default)(date)
+                        // 52 weeks in a year
+                        .add(52, 'weeks')
+                        .startOf('isoWeek')
+                        .toDate(),
+                    back: (date) => (0, dayjs_1.default)(date)
+                        // 52 weeks in a year
+                        .subtract(52, 'weeks')
+                        .startOf('isoWeek')
+                        .toDate(),
+                };
+            }
             return {
                 forward: (date) => (0, dayjs_1.default)(date).add(1, 'year').toDate(),
                 back: (date) => (0, dayjs_1.default)(date).subtract(1, 'year').toDate(),
             };
+        case timeFrames_1.TimeFrames.DAY:
+        case timeFrames_1.TimeFrames.WEEK:
+            throw new Error(`Timeframe "${timeFrame}" is not supported yet`);
         default:
             return (0, exports.assertUnimplementedTimeframe)(timeFrame);
     }
@@ -176,7 +190,18 @@ const getMetricExplorerDataPoints = (dimension, metric, metricRows, segmentDimen
     };
 };
 exports.getMetricExplorerDataPoints = getMetricExplorerDataPoints;
-const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, metric, metricRows, compareMetricRows, query) => {
+function offsetWeekCompareDates(groupByCompareMetricRows, timeFrame) {
+    return Object.fromEntries(Object.keys(groupByCompareMetricRows).map((compareDate) => {
+        const compareDateWeek = (0, dayjs_1.default)(compareDate).week();
+        const compareDateNextYear = (0, exports.getDateCalcUtils)(timeFrames_1.TimeFrames.YEAR, timeFrame).forward(new Date(compareDate));
+        const adjustedCompareDate = (0, dayjs_1.default)(compareDateNextYear)
+            .week(compareDateWeek)
+            .startOf('isoWeek')
+            .toISOString();
+        return [compareDate, adjustedCompareDate];
+    }));
+}
+const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, metric, metricRows, compareMetricRows, query, timeFrame) => {
     if (query.comparison === metricsExplorer_1.MetricExplorerComparison.NONE) {
         throw new Error('Comparison type is required');
     }
@@ -185,11 +210,17 @@ 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) => query.comparison === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD
-        ? (0, exports.getDateCalcUtils)(timeFrames_1.TimeFrames.YEAR)
-            .forward(new Date(date))
-            .toISOString()
-        : date);
+    const offsetGroupByCompareMetricRows = (0, lodash_1.mapKeys)(groupByCompareMetricRows, (_, date) => {
+        if (query.comparison === metricsExplorer_1.MetricExplorerComparison.PREVIOUS_PERIOD) {
+            if (timeFrame === timeFrames_1.TimeFrames.WEEK) {
+                return offsetWeekCompareDates(groupByCompareMetricRows, timeFrame)[date];
+            }
+            return (0, exports.getDateCalcUtils)(timeFrames_1.TimeFrames.YEAR, timeFrame)
+                .forward(new Date(date))
+                .toISOString();
+        }
+        return date;
+    });
     const dates = new Set([
         ...Object.keys(groupByMetricRows),
         ...Object.keys(offsetGroupByCompareMetricRows),
@@ -245,7 +276,7 @@ const getDefaultDateRangeFromInterval = (timeInterval) => {
             ];
         case timeFrames_1.TimeFrames.WEEK:
             return [
-                now.subtract(11, 'week').startOf('week').toDate(),
+                now.subtract(11, 'week').startOf('isoWeek').toDate(),
                 now.toDate(),
             ];
         case timeFrames_1.TimeFrames.MONTH:
@@ -269,7 +300,10 @@ const getDefaultDateRangeForMetricTotal = (timeFrame) => {
         case timeFrames_1.TimeFrames.DAY:
             return [now.startOf('day').toDate(), now.endOf('day').toDate()];
         case timeFrames_1.TimeFrames.WEEK:
-            return [now.startOf('week').toDate(), now.endOf('week').toDate()];
+            return [
+                now.startOf('isoWeek').toDate(),
+                now.endOf('isoWeek').toDate(),
+            ];
         case timeFrames_1.TimeFrames.MONTH:
             return [now.startOf('month').toDate(), now.endOf('month').toDate()];
         case timeFrames_1.TimeFrames.YEAR:

package/package.json

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