@lightdash/common 0.1369.1 → 0.1369.2

package/dist/types/csv.d.ts

@@ -1,4 +1,5 @@
 import { type MetricQuery } from './metricQuery';
+import { type PivotConfig } from './pivot';
 export type DownloadMetricCsv = {
     userUuid: string;
     projectUuid: string;
@@ -12,4 +13,5 @@ export type DownloadMetricCsv = {
     hiddenFields: string[] | undefined;
     chartName: string | undefined;
     fromSavedChart: boolean;
+    pivotConfig?: PivotConfig;
 };

package/dist/types/field.d.ts

@@ -247,4 +247,5 @@ export declare const isFilterableItem: (item: ItemsMap[string] | TableCalculatio
 export declare const defaultSql: (columnName: string) => string;
 export declare const capitalize: (word: string) => string;
 export declare const friendlyName: (text: string) => string;
+export declare const isSummable: (item: Item | undefined) => boolean;
 export {};

package/dist/types/field.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.friendlyName = exports.capitalize = exports.defaultSql = exports.isFilterableItem = exports.isFilterableField = exports.isFilterableDimension = exports.isNonAggregateMetric = exports.isMetric = exports.parseMetricType = exports.isFormat = exports.Format = exports.MetricType = exports.getFieldLabel = exports.getFieldRef = exports.isDimension = exports.DimensionType = exports.convertFieldRefToFieldId = exports.isField = exports.isTableCalculation = exports.FieldType = exports.TableCalculationType = exports.CustomFormatType = exports.isCompiledCustomSqlDimension = exports.isCustomSqlDimension = exports.isCustomBinDimension = exports.isCustomDimension = exports.CustomDimensionType = exports.BinType = exports.findCompactConfig = exports.CompactConfigMap = exports.NumberSeparator = exports.Compact = void 0;
+exports.isSummable = exports.friendlyName = exports.capitalize = exports.defaultSql = exports.isFilterableItem = exports.isFilterableField = exports.isFilterableDimension = exports.isNonAggregateMetric = exports.isMetric = exports.parseMetricType = exports.isFormat = exports.Format = exports.MetricType = exports.getFieldLabel = exports.getFieldRef = exports.isDimension = exports.DimensionType = exports.convertFieldRefToFieldId = exports.isField = exports.isTableCalculation = exports.FieldType = exports.TableCalculationType = exports.CustomFormatType = exports.isCompiledCustomSqlDimension = exports.isCustomSqlDimension = exports.isCustomBinDimension = exports.isCustomDimension = exports.CustomDimensionType = exports.BinType = exports.findCompactConfig = exports.CompactConfigMap = exports.NumberSeparator = exports.Compact = void 0;
 const errors_1 = require("./errors");
 var Compact;
 (function (Compact) {
@@ -269,3 +269,21 @@ const friendlyName = (text) => {
     return (0, exports.capitalize)(result);
 };
 exports.friendlyName = friendlyName;
+const isSummable = (item) => {
+    if (!item) {
+        return false;
+    }
+    if ((0, exports.isTableCalculation)(item)) {
+        return false;
+    }
+    if ((0, exports.isCustomDimension)(item)) {
+        return false;
+    }
+    const numericTypes = [MetricType.COUNT, MetricType.SUM];
+    const isNumberDimension = (0, exports.isDimension)(item) && item.type === DimensionType.NUMBER;
+    const isNumbericType = numericTypes.includes(item.type) || isNumberDimension;
+    const isPercent = item.format === 'percent';
+    const isDatePart = (0, exports.isDimension)(item) && item.timeInterval;
+    return isNumbericType && !isPercent && !isDatePart;
+};
+exports.isSummable = isSummable;

package/dist/types/scheduler.d.ts

@@ -1,6 +1,7 @@
 import { type Explore, type ExploreError } from './explore';
 import { type DashboardFilterRule } from './filter';
 import { type MetricQuery } from './metricQuery';
+import { type PivotConfig } from './pivot';
 import { type ValidationTarget } from './validation';
 export type SchedulerCsvOptions = {
     formatted: boolean;
@@ -233,6 +234,7 @@ export type DownloadCsvPayload = {
     hiddenFields: string[] | undefined;
     chartName: string | undefined;
     fromSavedChart: boolean;
+    pivotConfig?: PivotConfig;
 };
 export type ApiCsvUrlResponse = {
     status: 'ok';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lightdash/common",
-    "version": "0.1369.1",
+    "version": "0.1369.2",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "files": [
@@ -20,6 +20,7 @@
         "cronstrue": "^2.23.0",
         "dayjs": "^1.11.9",
         "dependency-graph": "^0.11.0",
+        "type-fest": "^3.10.0",
         "liquidjs": "^10.0.0",
         "lodash": "^4.17.21",
         "moment": "^2.29.4",