@lightdash/common 0.2434.2 → 0.2434.3

package/dist/esm/utils/chartValidation.d.ts

@@ -33,4 +33,35 @@ export declare function getUnusedDimensions(input: UnusedDimensionsInput): {
  * This is a convenience wrapper around getUnusedDimensions.
  */
 export declare function hasUnusedDimensions(input: UnusedDimensionsInput): boolean;
+/**
+ * Input for detecting unused table calculations in a cartesian chart.
+ */
+export type UnusedTableCalculationsInput = {
+    /** The chart configuration */
+    chartType: ChartType;
+    /** The chart config object (contains layout for cartesian charts) */
+    chartConfig: ChartConfig['config'] | undefined;
+    /** All table calculation names in the metric query */
+    queryTableCalculations: string[];
+};
+/**
+ * Detects table calculations in the query that are not used in the chart configuration.
+ *
+ * For cartesian charts, table calculations should be used in one of:
+ * - x-axis (xField)
+ * - y-axis (yField)
+ *
+ * If a table calculation is in the query but not used in any of these places,
+ * it may cause incorrect results (extra rows that don't aggregate properly).
+ *
+ * @returns Array of unused table calculation names, or empty array if none
+ */
+export declare function getUnusedTableCalculations(input: UnusedTableCalculationsInput): {
+    unusedTableCalculations: string[];
+};
+/**
+ * Checks if a chart has unused table calculations that may cause incorrect results.
+ * This is a convenience wrapper around getUnusedTableCalculations.
+ */
+export declare function hasUnusedTableCalculations(input: UnusedTableCalculationsInput): boolean;
 //# sourceMappingURL=chartValidation.d.ts.map

package/dist/esm/utils/chartValidation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chartValidation.d.ts","sourceRoot":"","sources":["../../../src/utils/chartValidation.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,SAAS,EAET,KAAK,WAAW,EACnB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC,8BAA8B;IAC9B,SAAS,EAAE,SAAS,CAAC;IACrB,qEAAqE;IACrE,WAAW,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;IAC/C,yCAAyC;IACzC,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,kDAAkD;IAClD,eAAe,EAAE,MAAM,EAAE,CAAC;CAC7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,qBAAqB,GAAG;IAC/D,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC9B,CA2CA;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAEzE"}
+{"version":3,"file":"chartValidation.d.ts","sourceRoot":"","sources":["../../../src/utils/chartValidation.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,SAAS,EAET,KAAK,WAAW,EACnB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC,8BAA8B;IAC9B,SAAS,EAAE,SAAS,CAAC;IACrB,qEAAqE;IACrE,WAAW,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;IAC/C,yCAAyC;IACzC,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,kDAAkD;IAClD,eAAe,EAAE,MAAM,EAAE,CAAC;CAC7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,qBAAqB,GAAG;IAC/D,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC9B,CA2CA;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAEzE;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACvC,8BAA8B;IAC9B,SAAS,EAAE,SAAS,CAAC;IACrB,qEAAqE;IACrE,WAAW,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;IAC/C,sDAAsD;IACtD,sBAAsB,EAAE,MAAM,EAAE,CAAC;CACpC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CACtC,KAAK,EAAE,4BAA4B,GACpC;IACC,uBAAuB,EAAE,MAAM,EAAE,CAAC;CACrC,CAqCA;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACtC,KAAK,EAAE,4BAA4B,GACpC,OAAO,CAET"}

package/dist/esm/utils/chartValidation.js

@@ -52,4 +52,51 @@ export function getUnusedDimensions(input) {
 export function hasUnusedDimensions(input) {
     return getUnusedDimensions(input).unusedDimensions.length > 0;
 }
+/**
+ * Detects table calculations in the query that are not used in the chart configuration.
+ *
+ * For cartesian charts, table calculations should be used in one of:
+ * - x-axis (xField)
+ * - y-axis (yField)
+ *
+ * If a table calculation is in the query but not used in any of these places,
+ * it may cause incorrect results (extra rows that don't aggregate properly).
+ *
+ * @returns Array of unused table calculation names, or empty array if none
+ */
+export function getUnusedTableCalculations(input) {
+    const { chartType, chartConfig, queryTableCalculations } = input;
+    if (chartType !== ChartType.CARTESIAN) {
+        return { unusedTableCalculations: [] };
+    }
+    if (queryTableCalculations.length === 0) {
+        return { unusedTableCalculations: [] };
+    }
+    const usedTableCalculations = new Set();
+    // Get layout from cartesian chart config
+    const cartesianConfig = chartConfig;
+    const layout = cartesianConfig?.layout;
+    // Add xField if it's a table calculation
+    if (layout?.xField && queryTableCalculations.includes(layout.xField)) {
+        usedTableCalculations.add(layout.xField);
+    }
+    // Add yField items if they're table calculations
+    if (layout?.yField) {
+        for (const field of layout.yField) {
+            if (queryTableCalculations.includes(field)) {
+                usedTableCalculations.add(field);
+            }
+        }
+    }
+    // Find query table calculations that are not used anywhere
+    const unusedTableCalculations = queryTableCalculations.filter((tc) => !usedTableCalculations.has(tc));
+    return { unusedTableCalculations };
+}
+/**
+ * Checks if a chart has unused table calculations that may cause incorrect results.
+ * This is a convenience wrapper around getUnusedTableCalculations.
+ */
+export function hasUnusedTableCalculations(input) {
+    return getUnusedTableCalculations(input).unusedTableCalculations.length > 0;
+}
 //# sourceMappingURL=chartValidation.js.map

package/dist/esm/utils/chartValidation.js.map

@@ -1 +1 @@
-{"version":3,"file":"chartValidation.js","sourceRoot":"","sources":["../../../src/utils/chartValidation.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,SAAS,GAGZ,MAAM,sBAAsB,CAAC;AAgB9B;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA4B;IAG5D,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;IAE3E,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC;QACpC,OAAO,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC;IACpC,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC;IACpC,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IAEzC,yCAAyC;IACzC,gFAAgF;IAChF,MAAM,eAAe,GAAG,WAAyC,CAAC;IAClE,MAAM,MAAM,GAAG,eAAe,EAAE,MAAM,CAAC;IAEvC,qEAAqE;IACrE,IAAI,MAAM,EAAE,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,yCAAyC;IACzC,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;IACL,CAAC;IAED,uEAAuE;IACvE,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;QACrC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,mDAAmD;IACnD,MAAM,gBAAgB,GAAG,eAAe,CAAC,MAAM,CAC3C,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CACpC,CAAC;IAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA4B;IAC5D,OAAO,mBAAmB,CAAC,KAAK,CAAC,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;AAClE,CAAC"}
+{"version":3,"file":"chartValidation.js","sourceRoot":"","sources":["../../../src/utils/chartValidation.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,SAAS,GAGZ,MAAM,sBAAsB,CAAC;AAgB9B;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA4B;IAG5D,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;IAE3E,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC;QACpC,OAAO,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC;IACpC,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC;IACpC,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IAEzC,yCAAyC;IACzC,gFAAgF;IAChF,MAAM,eAAe,GAAG,WAAyC,CAAC;IAClE,MAAM,MAAM,GAAG,eAAe,EAAE,MAAM,CAAC;IAEvC,qEAAqE;IACrE,IAAI,MAAM,EAAE,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,yCAAyC;IACzC,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;IACL,CAAC;IAED,uEAAuE;IACvE,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;QACrC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,mDAAmD;IACnD,MAAM,gBAAgB,GAAG,eAAe,CAAC,MAAM,CAC3C,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CACpC,CAAC;IAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA4B;IAC5D,OAAO,mBAAmB,CAAC,KAAK,CAAC,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;AAClE,CAAC;AAcD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,0BAA0B,CACtC,KAAmC;IAInC,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,KAAK,CAAC;IAEjE,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC;QACpC,OAAO,EAAE,uBAAuB,EAAE,EAAE,EAAE,CAAC;IAC3C,CAAC;IAED,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,uBAAuB,EAAE,EAAE,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAU,CAAC;IAEhD,yCAAyC;IACzC,MAAM,eAAe,GAAG,WAAyC,CAAC;IAClE,MAAM,MAAM,GAAG,eAAe,EAAE,MAAM,CAAC;IAEvC,yCAAyC;IACzC,IAAI,MAAM,EAAE,MAAM,IAAI,sBAAsB,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACnE,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED,iDAAiD;IACjD,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzC,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;QACL,CAAC;IACL,CAAC;IAED,2DAA2D;IAC3D,MAAM,uBAAuB,GAAG,sBAAsB,CAAC,MAAM,CACzD,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,CACzC,CAAC;IAEF,OAAO,EAAE,uBAAuB,EAAE,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CACtC,KAAmC;IAEnC,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAC,uBAAuB,CAAC,MAAM,GAAG,CAAC,CAAC;AAChF,CAAC"}