@lightdash/common 0.1406.0 → 0.1407.1

package/dist/index.d.ts

@@ -40,7 +40,7 @@ import { type ApiCatalogAnalyticsResults, type ApiCatalogMetadataResults, type A
 import { type ApiChartAsCodeListResponse, type ApiChartAsCodeUpsertResponse } from './types/coder';
 import { type ApiChartContentResponse, type ApiContentResponse } from './types/content';
 import type { ApiGroupListResponse } from './types/groups';
-import type { ApiMetricsExplorerQueryResults } from './types/metricsExplorer';
+import type { ApiMetricsExplorerQueryResults, ApiMetricsExplorerTotalResults } from './types/metricsExplorer';
 import { type ApiPromotionChangesResponse } from './types/promotion';
 import { type ApiSemanticLayerClientInfo, type ApiSemanticViewerChartCreate, type ApiSemanticViewerChartGet, type ApiSemanticViewerChartUpdate } from './types/semanticLayer';
 import { type ApiCreateSqlChart, type ApiCreateVirtualView, type ApiGithubDbtWritePreview, type ApiSqlChart, type ApiSqlRunnerJobStatusResponse, type ApiUpdateSqlChart } from './types/sqlRunner';
@@ -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'];
+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'];
 export type ApiResponse<T extends ApiResults = ApiResults> = {
     status: 'ok';
     results: T;

package/dist/types/catalog.d.ts

@@ -114,6 +114,7 @@ export type CatalogFieldMap = {
         fieldName: string;
         tableName: string;
         cachedExploreUuid: string;
+        fieldType: FieldType;
     };
 };
 export type CatalogItemSummary = Pick<CatalogItem, 'catalogSearchUuid' | 'name' | 'type'> & {
@@ -138,10 +139,35 @@ export type SchedulerIndexCatalogJobPayload = {
     prevCatalogItemsWithIcons: CatalogItemsWithIcons[];
     prevMetricTreeEdges: CatalogMetricsTreeEdge[];
 };
+export type ChartFieldUpdates = {
+    oldChartFields: {
+        metrics: string[];
+        dimensions: string[];
+    };
+    newChartFields: {
+        metrics: string[];
+        dimensions: string[];
+    };
+};
+export type ChartFieldChanges = {
+    added: {
+        dimensions: string[];
+        metrics: string[];
+    };
+    removed: {
+        dimensions: string[];
+        metrics: string[];
+    };
+};
 export type CatalogFieldWhere = {
     fieldName: string;
+    fieldType: FieldType;
     cachedExploreUuid: string;
 };
+export type ChartFieldUsageChanges = {
+    fieldsToIncrement: CatalogFieldWhere[];
+    fieldsToDecrement: CatalogFieldWhere[];
+};
 export type ChartUsageIn = CatalogFieldWhere & {
     chartUsage: number;
 };

package/dist/types/metricsExplorer.d.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { type MetricWithAssociatedTimeDimension } from './catalog';
 import type { ItemsMap } from './field';
+import type { ResultValue } from './results';
 export declare enum MetricExplorerComparison {
     NONE = "none",
     PREVIOUS_PERIOD = "previous_period",
@@ -52,3 +53,15 @@ export type ApiMetricsExplorerQueryResults = {
     status: 'ok';
     results: MetricsExplorerQueryResults;
 };
+export declare enum MetricTotalComparisonType {
+    NONE = "none",
+    PREVIOUS_PERIOD = "previous_period"
+}
+export type MetricTotalResults = {
+    value: ResultValue | undefined;
+    comparisonValue: ResultValue | undefined;
+};
+export type ApiMetricsExplorerTotalResults = {
+    status: 'ok';
+    results: MetricTotalResults;
+};

package/dist/types/metricsExplorer.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.metricExploreDataPointWithDateValueSchema = exports.MetricExplorerComparison = void 0;
+exports.MetricTotalComparisonType = exports.metricExploreDataPointWithDateValueSchema = exports.MetricExplorerComparison = void 0;
 const zod_1 = require("zod");
 var MetricExplorerComparison;
 (function (MetricExplorerComparison) {
@@ -16,3 +16,8 @@ const metricExploreDataPointSchema = zod_1.z.object({
 exports.metricExploreDataPointWithDateValueSchema = metricExploreDataPointSchema.extend({
     dateValue: zod_1.z.number(),
 });
+var MetricTotalComparisonType;
+(function (MetricTotalComparisonType) {
+    MetricTotalComparisonType["NONE"] = "none";
+    MetricTotalComparisonType["PREVIOUS_PERIOD"] = "previous_period";
+})(MetricTotalComparisonType = exports.MetricTotalComparisonType || (exports.MetricTotalComparisonType = {}));

package/dist/utils/metricsExplorer.d.ts

@@ -12,8 +12,10 @@ 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 oneYearBack: (date: Date) => Date;
-export declare const oneYearForward: (date: Date) => Date;
+export declare const getDateCalcUtils: (timeFrame: TimeFrames) => {
+    forward: (date: Date) => Date;
+    back: (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>;
@@ -28,6 +30,7 @@ export declare const getMetricExplorerDataPointsWithCompare: (dimension: Dimensi
  * @returns The date range
  */
 export declare const getDefaultDateRangeFromInterval: (timeInterval: TimeFrames) => MetricExplorerDateRange;
+export declare const getDefaultDateRangeForMetricTotal: (timeFrame: TimeFrames) => MetricExplorerDateRange;
 /**
  * Default time interval to use when no time interval is provided.
  * For example, when there is no default time dimension defined for a metric or table.

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.getDefaultDateRangeFromInterval = exports.getMetricExplorerDataPointsWithCompare = exports.getMetricExplorerDataPoints = exports.getMetricExplorerDateRangeFilters = exports.getGrainForDateRange = exports.oneYearForward = exports.oneYearBack = 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.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");
@@ -52,14 +52,33 @@ const getFieldIdForDateDimension = (fieldId, timeframe) => {
     }
 };
 exports.getFieldIdForDateDimension = getFieldIdForDateDimension;
-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;
+const getDateCalcUtils = (timeFrame) => {
+    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:
+            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:
+            return {
+                forward: (date) => (0, dayjs_1.default)(date).add(1, 'year').toDate(),
+                back: (date) => (0, dayjs_1.default)(date).subtract(1, 'year').toDate(),
+            };
+        default:
+            return (0, exports.assertUnimplementedTimeframe)(timeFrame);
+    }
+};
+exports.getDateCalcUtils = getDateCalcUtils;
 // 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)
@@ -126,7 +145,9 @@ const getMetricExplorerDataPointsWithCompare = (dimension, compareDimension, met
     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
-        ? (0, exports.oneYearForward)(new Date(date)).toISOString()
+        ? (0, exports.getDateCalcUtils)(timeFrames_1.TimeFrames.YEAR)
+            .back(new Date(date))
+            .toISOString()
         : date);
     const dates = new Set([
         ...Object.keys(groupByMetricRows),
@@ -183,6 +204,22 @@ const getDefaultDateRangeFromInterval = (timeInterval) => {
     }
 };
 exports.getDefaultDateRangeFromInterval = getDefaultDateRangeFromInterval;
+const getDefaultDateRangeForMetricTotal = (timeFrame) => {
+    const now = (0, dayjs_1.default)();
+    switch (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()];
+        case timeFrames_1.TimeFrames.MONTH:
+            return [now.startOf('month').toDate(), now.endOf('month').toDate()];
+        case timeFrames_1.TimeFrames.YEAR:
+            return [now.startOf('year').toDate(), now.endOf('year').toDate()];
+        default:
+            return (0, exports.assertUnimplementedTimeframe)(timeFrame);
+    }
+};
+exports.getDefaultDateRangeForMetricTotal = getDefaultDateRangeForMetricTotal;
 /**
  * Default time interval to use when no time interval is provided.
  * For example, when there is no default time dimension defined for a metric or table.

package/package.json

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