@lightdash/common 0.2104.6 → 0.2104.8

package/dist/types/visualizations/helpers/getCartesianAxisFormatterConfig.js

@@ -0,0 +1,142 @@
+import { DimensionType, isDimension, isField, isTableCalculation, } from '../../types/field';
+import { TimeFrames } from '../../types/timeFrames';
+import { formatItemValue, hasFormatting } from '../../utils/formatting';
+import { isTimeInterval, timeFrameConfigs } from '../../utils/timeFrames';
+/**
+ * Get the formatter config for a cartesian axis
+ * @param axisItem - Axis item
+ * @param longestLabelWidth - Longest label width
+ * @param rotate - Rotate
+ * @param defaultNameGap - Default name gap
+ * @param show - Show
+ * @returns Axis config
+ */
+export const getCartesianAxisFormatterConfig = ({ axisItem, longestLabelWidth, rotate, defaultNameGap, show, }) => {
+    // Remove axis labels, lines, and ticks if the axis is not shown
+    // This is done to prevent the grid from disappearing when the axis is not shown
+    if (!show) {
+        return {
+            axisLabel: undefined,
+            axisLine: {
+                show,
+            },
+            axisTick: {
+                show,
+            },
+        };
+    }
+    const isTimestamp = isField(axisItem) &&
+        (axisItem.type === DimensionType.DATE ||
+            axisItem.type === DimensionType.TIMESTAMP);
+    // Only apply axis formatting if the axis is NOT a date or timestamp
+    const hasFormattingConfig = !isTimestamp && hasFormatting(axisItem);
+    const axisMinInterval = isDimension(axisItem) &&
+        axisItem.timeInterval &&
+        isTimeInterval(axisItem.timeInterval) &&
+        timeFrameConfigs[axisItem.timeInterval].getAxisMinInterval();
+    const axisLabelFormatter = isDimension(axisItem) &&
+        axisItem.timeInterval &&
+        isTimeInterval(axisItem.timeInterval) &&
+        timeFrameConfigs[axisItem.timeInterval].getAxisLabelFormatter();
+    const axisConfig = {};
+    if (axisItem && (hasFormattingConfig || axisMinInterval)) {
+        axisConfig.axisLabel = {
+            formatter: (value) => formatItemValue(axisItem, value, true),
+        };
+        axisConfig.axisPointer = {
+            label: {
+                formatter: (value) => value &&
+                    typeof value === 'object' &&
+                    'value' in value &&
+                    value.value !== undefined
+                    ? formatItemValue(axisItem, value.value, true)
+                    : undefined,
+            },
+        };
+    }
+    else if (axisLabelFormatter) {
+        axisConfig.axisLabel = {
+            formatter: axisLabelFormatter,
+            rich: {
+                bold: {
+                    fontWeight: 'bold',
+                },
+            },
+        };
+        axisConfig.axisPointer = {
+            label: {
+                formatter: (value) => value &&
+                    typeof value === 'object' &&
+                    'value' in value &&
+                    value.value !== undefined
+                    ? formatItemValue(axisItem, value.value, true)
+                    : undefined,
+            },
+        };
+    }
+    else if (axisItem !== undefined &&
+        isTableCalculation(axisItem) &&
+        axisItem.type === undefined) {
+        axisConfig.axisLabel = {
+            formatter: (value) => formatItemValue(axisItem, value),
+        };
+        axisConfig.axisPointer = {
+            label: {
+                formatter: (value) => value &&
+                    typeof value === 'object' &&
+                    'value' in value &&
+                    value.value !== undefined
+                    ? formatItemValue(axisItem, value.value)
+                    : undefined,
+            },
+        };
+    }
+    else if (axisItem &&
+        isDimension(axisItem) &&
+        axisItem.timeInterval &&
+        isTimeInterval(axisItem.timeInterval)) {
+        // Some int numbers are converted to float by default on echarts
+        // This is to ensure the value is correctly formatted on some types
+        switch (axisItem.timeInterval) {
+            case TimeFrames.WEEK_NUM:
+            case TimeFrames.WEEK:
+                axisConfig.axisLabel = {
+                    formatter: (value) => formatItemValue(axisItem, value, true),
+                };
+                axisConfig.axisPointer = {
+                    label: {
+                        formatter: (value) => value &&
+                            typeof value === 'object' &&
+                            'value' in value &&
+                            value.value !== undefined
+                            ? formatItemValue(axisItem, value.value, true)
+                            : undefined,
+                    },
+                };
+                break;
+            default:
+        }
+    }
+    if (axisMinInterval) {
+        axisConfig.minInterval = axisMinInterval;
+    }
+    axisConfig.nameGap = defaultNameGap || 0;
+    if (rotate) {
+        const rotateRadians = (rotate * Math.PI) / 180;
+        const oppositeSide = (longestLabelWidth || 0) * Math.sin(rotateRadians);
+        axisConfig.axisLabel = {
+            ...(axisConfig.axisLabel || {}),
+            rotate,
+            margin: 12,
+        };
+        axisConfig.nameGap = oppositeSide + 15;
+    }
+    else {
+        axisConfig.axisLabel = {
+            ...(axisConfig.axisLabel || {}),
+            hideOverlap: true,
+        };
+    }
+    return axisConfig;
+};
+//# sourceMappingURL=getCartesianAxisFormatterConfig.js.map

package/dist/types/visualizations/helpers/getCartesianAxisFormatterConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCartesianAxisFormatterConfig.js","sourceRoot":"","sources":["../../../../src/visualizations/helpers/getCartesianAxisFormatterConfig.ts"],"names":[],"mappings":"AACA,OAAO,EACH,aAAa,EACb,WAAW,EACX,OAAO,EACP,kBAAkB,GAErB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1E;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,EAC5C,QAAQ,EACR,iBAAiB,EACjB,MAAM,EACN,cAAc,EACd,IAAI,GAOP,EAAE,EAAE;IACD,gEAAgE;IAChE,gFAAgF;IAChF,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,OAAO;YACH,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE;gBACN,IAAI;aACP;YACD,QAAQ,EAAE;gBACN,IAAI;aACP;SACJ,CAAC;IACN,CAAC;IAED,MAAM,WAAW,GACb,OAAO,CAAC,QAAQ,CAAC;QACjB,CAAC,QAAQ,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI;YACjC,QAAQ,CAAC,IAAI,KAAK,aAAa,CAAC,SAAS,CAAC,CAAC;IACnD,oEAAoE;IACpE,MAAM,mBAAmB,GAAG,CAAC,WAAW,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpE,MAAM,eAAe,GACjB,WAAW,CAAC,QAAQ,CAAC;QACrB,QAAQ,CAAC,YAAY;QACrB,cAAc,CAAC,QAAQ,CAAC,YAAY,CAAC;QACrC,gBAAgB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAEjE,MAAM,kBAAkB,GACpB,WAAW,CAAC,QAAQ,CAAC;QACrB,QAAQ,CAAC,YAAY;QACrB,cAAc,CAAC,QAAQ,CAAC,YAAY,CAAC;QACrC,gBAAgB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,qBAAqB,EAAE,CAAC;IAEpE,MAAM,UAAU,GAA4B,EAAE,CAAC;IAE/C,IAAI,QAAQ,IAAI,CAAC,mBAAmB,IAAI,eAAe,CAAC,EAAE,CAAC;QACvD,UAAU,CAAC,SAAS,GAAG;YACnB,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE,CAC1B,eAAe,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;SAC7C,CAAC;QACF,UAAU,CAAC,WAAW,GAAG;YACrB,KAAK,EAAE;gBACH,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE,CAC1B,KAAK;oBACL,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,IAAI,KAAK;oBAChB,KAAK,CAAC,KAAK,KAAK,SAAS;oBACrB,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC;oBAC9C,CAAC,CAAC,SAAS;aACtB;SACJ,CAAC;IACN,CAAC;SAAM,IAAI,kBAAkB,EAAE,CAAC;QAC5B,UAAU,CAAC,SAAS,GAAG;YACnB,SAAS,EAAE,kBAAkB;YAC7B,IAAI,EAAE;gBACF,IAAI,EAAE;oBACF,UAAU,EAAE,MAAM;iBACrB;aACJ;SACJ,CAAC;QACF,UAAU,CAAC,WAAW,GAAG;YACrB,KAAK,EAAE;gBACH,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE,CAC1B,KAAK;oBACL,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,IAAI,KAAK;oBAChB,KAAK,CAAC,KAAK,KAAK,SAAS;oBACrB,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC;oBAC9C,CAAC,CAAC,SAAS;aACtB;SACJ,CAAC;IACN,CAAC;SAAM,IACH,QAAQ,KAAK,SAAS;QACtB,kBAAkB,CAAC,QAAQ,CAAC;QAC5B,QAAQ,CAAC,IAAI,KAAK,SAAS,EAC7B,CAAC;QACC,UAAU,CAAC,SAAS,GAAG;YACnB,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC;SAClE,CAAC;QACF,UAAU,CAAC,WAAW,GAAG;YACrB,KAAK,EAAE;gBACH,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE,CAC1B,KAAK;oBACL,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,IAAI,KAAK;oBAChB,KAAK,CAAC,KAAK,KAAK,SAAS;oBACrB,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC;oBACxC,CAAC,CAAC,SAAS;aACtB;SACJ,CAAC;IACN,CAAC;SAAM,IACH,QAAQ;QACR,WAAW,CAAC,QAAQ,CAAC;QACrB,QAAQ,CAAC,YAAY;QACrB,cAAc,CAAC,QAAQ,CAAC,YAAY,CAAC,EACvC,CAAC;QACC,gEAAgE;QAChE,mEAAmE;QACnE,QAAQ,QAAQ,CAAC,YAAY,EAAE,CAAC;YAC5B,KAAK,UAAU,CAAC,QAAQ,CAAC;YACzB,KAAK,UAAU,CAAC,IAAI;gBAChB,UAAU,CAAC,SAAS,GAAG;oBACnB,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE,CAC1B,eAAe,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;iBAC7C,CAAC;gBAEF,UAAU,CAAC,WAAW,GAAG;oBACrB,KAAK,EAAE;wBACH,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE,CAC1B,KAAK;4BACL,OAAO,KAAK,KAAK,QAAQ;4BACzB,OAAO,IAAI,KAAK;4BAChB,KAAK,CAAC,KAAK,KAAK,SAAS;4BACrB,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC;4BAC9C,CAAC,CAAC,SAAS;qBACtB;iBACJ,CAAC;gBACF,MAAM;YACV,QAAQ;QACZ,CAAC;IACL,CAAC;IACD,IAAI,eAAe,EAAE,CAAC;QAClB,UAAU,CAAC,WAAW,GAAG,eAAe,CAAC;IAC7C,CAAC;IAED,UAAU,CAAC,OAAO,GAAG,cAAc,IAAI,CAAC,CAAC;IACzC,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,aAAa,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;QAC/C,MAAM,YAAY,GAAG,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACxE,UAAU,CAAC,SAAS,GAAG;YACnB,GAAG,CAAC,UAAU,CAAC,SAAS,IAAI,EAAE,CAAC;YAC/B,MAAM;YACN,MAAM,EAAE,EAAE;SACb,CAAC;QACF,UAAU,CAAC,OAAO,GAAG,YAAY,GAAG,EAAE,CAAC;IAC3C,CAAC;SAAM,CAAC;QACJ,UAAU,CAAC,SAAS,GAAG;YACnB,GAAG,CAAC,UAAU,CAAC,SAAS,IAAI,EAAE,CAAC;YAC/B,WAAW,EAAE,IAAI;SACpB,CAAC;IACN,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC,CAAC"}

package/dist/types/visualizations/types/IResultsRunner.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IResultsRunner.js.map

package/dist/types/visualizations/types/IResultsRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IResultsRunner.js","sourceRoot":"","sources":["../../../../src/visualizations/types/IResultsRunner.ts"],"names":[],"mappings":""}

package/dist/types/visualizations/types/index.js

@@ -0,0 +1,78 @@
+import { DimensionType, TableCalculationType } from '../../types/field';
+import { ChartKind } from '../../types/savedCharts';
+export var VizAggregationOptions;
+(function (VizAggregationOptions) {
+    VizAggregationOptions["SUM"] = "sum";
+    VizAggregationOptions["COUNT"] = "count";
+    VizAggregationOptions["AVERAGE"] = "avg";
+    VizAggregationOptions["MIN"] = "min";
+    VizAggregationOptions["MAX"] = "max";
+    VizAggregationOptions["ANY"] = "any";
+})(VizAggregationOptions || (VizAggregationOptions = {}));
+export var SortByDirection;
+(function (SortByDirection) {
+    SortByDirection["ASC"] = "ASC";
+    SortByDirection["DESC"] = "DESC";
+})(SortByDirection || (SortByDirection = {}));
+export const vizAggregationOptions = [
+    VizAggregationOptions.SUM,
+    VizAggregationOptions.COUNT,
+    VizAggregationOptions.AVERAGE,
+    VizAggregationOptions.MIN,
+    VizAggregationOptions.MAX,
+    VizAggregationOptions.ANY,
+];
+export const VIZ_DEFAULT_AGGREGATION = VizAggregationOptions.COUNT;
+export var VizIndexType;
+(function (VizIndexType) {
+    VizIndexType["TIME"] = "time";
+    VizIndexType["CATEGORY"] = "category";
+})(VizIndexType || (VizIndexType = {}));
+export var AxisSide;
+(function (AxisSide) {
+    AxisSide[AxisSide["LEFT"] = 0] = "LEFT";
+    AxisSide[AxisSide["RIGHT"] = 1] = "RIGHT";
+})(AxisSide || (AxisSide = {}));
+export var StackType;
+(function (StackType) {
+    StackType["NONE"] = "none";
+    StackType["NORMAL"] = "stack";
+    StackType["PERCENT"] = "stack100";
+})(StackType || (StackType = {}));
+export function getColumnAxisType(dimensionType) {
+    switch (dimensionType) {
+        case DimensionType.DATE:
+        case DimensionType.TIMESTAMP:
+            return VizIndexType.TIME;
+        case DimensionType.BOOLEAN:
+        case DimensionType.NUMBER:
+        case DimensionType.STRING:
+        default:
+            return VizIndexType.CATEGORY;
+    }
+}
+export function getTableCalculationAxisType(tableCalculationType) {
+    switch (tableCalculationType) {
+        case TableCalculationType.DATE:
+        case TableCalculationType.TIMESTAMP:
+            return VizIndexType.TIME;
+        default:
+            return VizIndexType.CATEGORY;
+    }
+}
+export const isPivotChartLayout = (obj) => {
+    if (typeof obj !== 'object' || obj === null) {
+        return false;
+    }
+    if (!('y' in obj) && !('groupBy' in obj) && !('x' in obj)) {
+        return false;
+    }
+    return true;
+};
+export const isVizBarChartConfig = (value) => !!value && value.type === ChartKind.VERTICAL_BAR;
+export const isVizLineChartConfig = (value) => !!value && value.type === ChartKind.LINE;
+export const isVizCartesianChartConfig = (value) => !!value &&
+    (value.type === ChartKind.LINE || value.type === ChartKind.VERTICAL_BAR);
+export const isVizPieChartConfig = (value) => !!value && value.type === ChartKind.PIE;
+export const isVizTableConfig = (value) => !!value && value.type === ChartKind.TABLE;
+//# sourceMappingURL=index.js.map

package/dist/types/visualizations/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/visualizations/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAGxE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAGpD,MAAM,CAAN,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAC7B,oCAAW,CAAA;IACX,wCAAe,CAAA;IACf,wCAAe,CAAA;IACf,oCAAW,CAAA;IACX,oCAAW,CAAA;IACX,oCAAW,CAAA;AACf,CAAC,EAPW,qBAAqB,KAArB,qBAAqB,QAOhC;AAED,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,8BAAW,CAAA;IACX,gCAAa,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAED,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACjC,qBAAqB,CAAC,GAAG;IACzB,qBAAqB,CAAC,KAAK;IAC3B,qBAAqB,CAAC,OAAO;IAC7B,qBAAqB,CAAC,GAAG;IACzB,qBAAqB,CAAC,GAAG;IACzB,qBAAqB,CAAC,GAAG;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,qBAAqB,CAAC,KAAK,CAAC;AAUnE,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,6BAAa,CAAA;IACb,qCAAqB,CAAA;AACzB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAED,MAAM,CAAN,IAAY,QAGX;AAHD,WAAY,QAAQ;IAChB,uCAAI,CAAA;IACJ,yCAAK,CAAA;AACT,CAAC,EAHW,QAAQ,KAAR,QAAQ,QAGnB;AAED,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,0BAAa,CAAA;IACb,6BAAgB,CAAA;IAChB,iCAAoB,CAAA;AACxB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAED,MAAM,UAAU,iBAAiB,CAAC,aAA4B;IAC1D,QAAQ,aAAa,EAAE,CAAC;QACpB,KAAK,aAAa,CAAC,IAAI,CAAC;QACxB,KAAK,aAAa,CAAC,SAAS;YACxB,OAAO,YAAY,CAAC,IAAI,CAAC;QAC7B,KAAK,aAAa,CAAC,OAAO,CAAC;QAC3B,KAAK,aAAa,CAAC,MAAM,CAAC;QAC1B,KAAK,aAAa,CAAC,MAAM,CAAC;QAC1B;YACI,OAAO,YAAY,CAAC,QAAQ,CAAC;IACrC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,2BAA2B,CACvC,oBAA0C;IAE1C,QAAQ,oBAAoB,EAAE,CAAC;QAC3B,KAAK,oBAAoB,CAAC,IAAI,CAAC;QAC/B,KAAK,oBAAoB,CAAC,SAAS;YAC/B,OAAO,YAAY,CAAC,IAAI,CAAC;QAC7B;YACI,OAAO,YAAY,CAAC,QAAQ,CAAC;IACrC,CAAC;AACL,CAAC;AAoFD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAC9B,GAAoD,EAC7B,EAAE;IACzB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC;QACxD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAsFF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAC/B,KAAgC,EACN,EAAE,CAC5B,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,YAAY,CAAC;AAErD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAChC,KAAgC,EACL,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC;AAE3E,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACrC,KAAgC,EACA,EAAE,CAClC,CAAC,CAAC,KAAK;IACP,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,YAAY,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAC/B,KAAgC,EACN,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,GAAG,CAAC;AAEzE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC5B,KAAgC,EACT,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,KAAK,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/common",
-  "version": "0.2104.6",
+  "version": "0.2104.8",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",