@lightdash/common 0.1431.0 → 0.1432.0

package/dist/types/metricQuery.d.ts

@@ -1,4 +1,4 @@
-import { type CompactOrAlias, type CompiledCustomDimension, type CompiledDimension, type CompiledMetric, type CompiledTableCalculation, type CustomDimension, type CustomFormat, type FieldId, type Format, type MetricType, type TableCalculation } from './field';
+import { type CompactOrAlias, type CompiledCustomDimension, type CompiledDimension, type CompiledMetric, type CompiledTableCalculation, type CustomDimension, type CustomFormat, type FieldId, type Format, type Metric, type MetricType, type TableCalculation } from './field';
 import { type Filters, type MetricFilterRule } from './filter';
 import { type DateGranularity } from './timeFrames';
 export interface AdditionalMetric {
@@ -20,10 +20,13 @@ export interface AdditionalMetric {
     formatOptions?: CustomFormat;
 }
 export declare const isAdditionalMetric: (value: any) => value is AdditionalMetric;
-export declare const hasFormatOptions: (value: any) => value is AdditionalMetric & {
+export declare const hasFormatOptions: (value: any) => value is {
     formatOptions: CustomFormat;
 };
 export declare const getCustomMetricDimensionId: (metric: AdditionalMetric) => string;
+export type MetricOverrides = {
+    [key: string]: Pick<Metric, 'formatOptions'>;
+};
 export type MetricQuery = {
     exploreName: string;
     dimensions: FieldId[];
@@ -34,6 +37,7 @@ export type MetricQuery = {
     tableCalculations: TableCalculation[];
     additionalMetrics?: AdditionalMetric[];
     customDimensions?: CustomDimension[];
+    metricOverrides?: MetricOverrides;
     timezone?: string;
     metadata?: {
         hasADateDimension: Pick<CompiledDimension, 'label' | 'name'>;
@@ -100,5 +104,6 @@ export type MetricQueryRequest = {
     granularity?: DateGranularity;
     metadata?: MetricQuery['metadata'];
     timezone?: string;
+    metricOverrides?: MetricOverrides;
 };
 export {};

package/dist/utils/formatting.d.ts

@@ -19,6 +19,7 @@ export declare function getCustomFormatFromLegacy({ format, compact, round, }: {
     compact?: CompactOrAlias;
     round?: number;
 }): CustomFormat;
+export declare function hasFormatting(item: Field | AdditionalMetric | TableCalculation | CustomDimension | undefined): boolean;
 export declare function getCustomFormat(item: Field | AdditionalMetric | TableCalculation | CustomDimension | undefined): CustomFormat | undefined;
 export declare function applyCustomFormat(value: unknown, format?: CustomFormat | undefined): string;
 export declare function formatItemValue(item: Field | Dimension | AdditionalMetric | TableCalculation | CustomDimension | undefined, value: unknown, convertToUTC?: boolean): string;

package/dist/utils/formatting.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatItemValue = exports.applyCustomFormat = exports.getCustomFormat = exports.getCustomFormatFromLegacy = exports.formatNumberValue = exports.isNumber = exports.valueIsNaN = exports.parseTimestamp = exports.parseDate = exports.getLocalTimeDisplay = exports.formatTimestamp = exports.formatDate = exports.isMomentInput = exports.getDateFormat = exports.formatBoolean = exports.currencies = void 0;
+exports.formatItemValue = exports.applyCustomFormat = exports.getCustomFormat = exports.hasFormatting = exports.getCustomFormatFromLegacy = exports.formatNumberValue = exports.isNumber = exports.valueIsNaN = exports.parseTimestamp = exports.parseDate = exports.getLocalTimeDisplay = exports.formatTimestamp = exports.formatDate = exports.isMomentInput = exports.getDateFormat = exports.formatBoolean = exports.currencies = void 0;
 const tslib_1 = require("tslib");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const timezone_1 = tslib_1.__importDefault(require("dayjs/plugin/timezone"));
@@ -220,6 +220,23 @@ function getCustomFormatFromLegacy({ format, compact, round, }) {
     }
 }
 exports.getCustomFormatFromLegacy = getCustomFormatFromLegacy;
+function hasFormatting(item) {
+    if (!item)
+        return false;
+    if ((0, metricQuery_1.hasFormatOptions)(item)) {
+        return true;
+    }
+    if ((0, field_1.isTableCalculation)(item)) {
+        return item.format !== undefined;
+    }
+    if ((0, field_1.isDimension)(item) || (0, field_1.isMetric)(item)) {
+        return (item.format !== undefined ||
+            item.compact !== undefined ||
+            item.round !== undefined);
+    }
+    return false;
+}
+exports.hasFormatting = hasFormatting;
 function getCustomFormat(item) {
     if (!item)
         return undefined;

package/package.json

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