@cellaware/utils 8.11.16 → 8.11.18

package/dist/chatwms/datagrid.d.ts

@@ -21,6 +21,7 @@ export interface VisualDatagridState extends DatagridState {
 }
 export declare function initVisualDatagridState(): VisualDatagridState;
 export type ColumnState = {
+    /** Maps to ColumnFormat `name`. */
     colId: string;
     hide?: boolean | null;
     sort?: 'asc' | 'desc' | null;
@@ -30,6 +31,7 @@ export type ColumnState = {
     pivotIndex?: number | null;
     rowGroup?: boolean;
     rowGroupIndex?: number | null;
+    pinned?: 'left' | 'right' | null;
 };
 type FilterType = 'text' | 'number' | 'set';
 type Operator = 'AND' | 'OR';
@@ -48,6 +50,7 @@ type CompoundFilter = {
 type ColumnFilter = SimpleCondition | CompoundFilter;
 type FilterModel = Record<string, ColumnFilter>;
 export interface ColumnFormat {
+    /** Maps to ColumnState `colId`. */
     name: string;
     displayName: string;
     /** `text` | `number` | `date` | `boolean` */

package/dist/chatwms/datagrid.js

@@ -685,8 +685,9 @@ function pivotData(data, rowGroupCols, pivotCols, valueCols) {
         const pivotBuckets = new Map();
         for (const row of groupRows) {
             const pivotKey = pivotBy(row);
-            if (!pivotBuckets.has(pivotKey))
+            if (!pivotBuckets.has(pivotKey)) {
                 pivotBuckets.set(pivotKey, []);
+            }
             pivotBuckets.get(pivotKey).push(row);
         }
         for (const [pivotKey, rows] of pivotBuckets.entries()) {
@@ -704,29 +705,50 @@ function pivotData(data, rowGroupCols, pivotCols, valueCols) {
                 switch (aggFunc) {
                     case 'sum':
                         groupObj[key] = values.map(Number).reduce((a, b) => a + b, 0);
+                        if (!groupObj[key]) {
+                            groupObj[key] = 0;
+                        }
                         break;
                     case 'count':
                         groupObj[key] = values.length;
+                        if (!groupObj[key]) {
+                            groupObj[key] = 0;
+                        }
                         break;
                     case 'min':
                         groupObj[key] = values.reduce((a, b) => (a < b ? a : b), values[0]);
+                        if (!groupObj[key]) {
+                            groupObj[key] = 0;
+                        }
                         break;
                     case 'max':
                         groupObj[key] = values.reduce((a, b) => (a > b ? a : b), values[0]);
+                        if (!groupObj[key]) {
+                            groupObj[key] = 0;
+                        }
                         break;
                     case 'avg': {
                         const nums = values.map(Number).filter(n => !isNaN(n));
                         groupObj[key] = nums.length ? nums.reduce((a, b) => a + b, 0) / nums.length : null;
+                        if (!groupObj[key]) {
+                            groupObj[key] = 0;
+                        }
                         break;
                     }
                     case 'first':
                         groupObj[key] = values[0];
+                        if (!groupObj[key]) {
+                            groupObj[key] = '';
+                        }
                         break;
                     case 'last':
                         groupObj[key] = values[values.length - 1];
+                        if (!groupObj[key]) {
+                            groupObj[key] = '';
+                        }
                         break;
                     default:
-                        groupObj[key] = null;
+                        groupObj[key] = '';
                 }
             }
         }
@@ -1223,6 +1245,25 @@ export function createTeamsTransposeTableRow(row, columnStyle) {
         cells: [keyCell, valueCell]
     };
 }
+function getColumnSequenceRank(column, pivot) {
+    let seq = 2;
+    // Check pin state first.
+    // Important: we do not care about pinning if the grid is pivoted.
+    if (!pivot) {
+        if (column.pinned === 'left') {
+            seq = 0;
+        }
+        else if (column.pinned === 'right') {
+            seq = 3;
+        }
+    }
+    // Row group second.
+    if (!!column.rowGroup && column.rowGroupIndex === 0) {
+        seq = 1;
+    }
+    // Nothing else to check.
+    return seq;
+}
 /**
  * **Important:** `html` and `teamsRows` output will be limited to **1,000 rows/24 rows** and **8 columns**, respectively.
  *
@@ -1250,8 +1291,11 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
         rows = pivotOutput.rows;
         rows = sortModel.length > 0 ? sortRows(rows, sortModel) : rows;
         let mappedDisplayColumnNames = new Map();
-        // Should not need to do hidden/visible column analysis -- pivoting creates new results with only the necessary columns.
-        // Also should not need to analyze column sequence -- our newly created results *should* respect the correct sequence.
+        // For pivots, we cannot trust the `hide` field.
+        // Visibility will depend on `rowGroup`, `pivot`, and `aggFunc`.
+        const visibleColumnState = columnState.filter(column => (!!column.rowGroup && column.rowGroupIndex === 0) || // We only display the **first** row group.
+            (!!column.pivot) ||
+            (!!column.aggFunc)).sort((a, b) => getColumnSequenceRank(a, true) - getColumnSequenceRank(b, true));
         let rowIdx = 0;
         rows.forEach((row) => {
             let adjRow = {};
@@ -1262,49 +1306,54 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
             let htmlTransposeColumnStyles = [];
             let teamsRowStyles = [];
             let teamsColumnStyles = [];
-            columnFormats.forEach(columnFormat => {
-                if (columnFormat.name in row) {
-                    const value = row[columnFormat.name];
-                    const formattedValue = evaluateValueFormat(columnFormat, value, locale);
-                    adjRow[columnFormat.displayName] = formattedValue;
-                    chartRow[columnFormat.displayName] = formatNumberEnabled(columnFormat.valueFormat) ? value : formattedValue;
-                    htmlRowValues.push(formattedValue);
-                    [htmlRowStyles, htmlColumnStyles] = processHtmlStyles(formattedValue, columnFormat.displayName, columnFormat, htmlRowStyles, htmlColumnStyles);
-                    htmlTransposeColumnStyles = processHtmlTransposeStyles(formattedValue, columnFormat.displayName, columnFormat, htmlTransposeColumnStyles);
-                    if (rowIdx === 0) {
-                        htmlColumnNames.push(columnFormat.displayName);
+            // Important: anchoring to column state will ensure we add columns in the correct sequence.
+            visibleColumnState.forEach(column => {
+                const columnFormat = columnFormats.find(columnFormat => columnFormat.name === column.colId);
+                if (!!columnFormat) {
+                    if (columnFormat.name in row) {
+                        const value = row[columnFormat.name];
+                        const formattedValue = evaluateValueFormat(columnFormat, value, locale);
+                        adjRow[columnFormat.displayName] = formattedValue;
+                        chartRow[columnFormat.displayName] = formatNumberEnabled(columnFormat.valueFormat) ? value : formattedValue;
+                        htmlRowValues.push(formattedValue);
+                        [htmlRowStyles, htmlColumnStyles] = processHtmlStyles(formattedValue, columnFormat.displayName, columnFormat, htmlRowStyles, htmlColumnStyles);
+                        htmlTransposeColumnStyles = processHtmlTransposeStyles(formattedValue, columnFormat.displayName, columnFormat, htmlTransposeColumnStyles);
+                        if (rowIdx === 0) {
+                            htmlColumnNames.push(columnFormat.displayName);
+                        }
                     }
-                }
-                else {
-                    const mappedColumnNamesSet = pivotOutput.mappedColumnNames.get(columnFormat.name);
-                    if (!!mappedColumnNamesSet) {
-                        const mappedColumnNamesArr = Array.from(mappedColumnNamesSet);
-                        for (const mappedColumnName of mappedColumnNamesArr) {
-                            if (mappedColumnName in row) {
-                                const adjDisplayName = mappedColumnName.replace(columnFormat.name, columnFormat.displayName);
-                                const value = row[mappedColumnName];
-                                const formattedValue = evaluateValueFormat(columnFormat, value, locale);
-                                adjRow[adjDisplayName] = formattedValue;
-                                chartRow[adjDisplayName] = formatNumberEnabled(columnFormat.valueFormat) ? value : formattedValue;
-                                htmlRowValues.push(formattedValue);
-                                [htmlRowStyles, htmlColumnStyles] = processHtmlStyles(formattedValue, adjDisplayName, columnFormat, htmlRowStyles, htmlColumnStyles);
-                                htmlTransposeColumnStyles = processHtmlTransposeStyles(formattedValue, adjDisplayName, columnFormat, htmlTransposeColumnStyles);
-                                if (rowIdx === 0) {
-                                    htmlColumnNames.push(adjDisplayName);
-                                }
-                                let displayColumnNames = mappedDisplayColumnNames.get(columnFormat.displayName);
-                                if (!!displayColumnNames) {
-                                    displayColumnNames.add(adjDisplayName);
-                                }
-                                else {
-                                    displayColumnNames = new Set([adjDisplayName]);
-                                    mappedDisplayColumnNames.set(columnFormat.displayName, displayColumnNames);
+                    else {
+                        const mappedColumnNamesSet = pivotOutput.mappedColumnNames.get(columnFormat.name);
+                        if (!!mappedColumnNamesSet) {
+                            const mappedColumnNamesArr = Array.from(mappedColumnNamesSet);
+                            for (const mappedColumnName of mappedColumnNamesArr) {
+                                if (mappedColumnName in row) {
+                                    const adjDisplayName = mappedColumnName.replace(columnFormat.name, columnFormat.displayName);
+                                    const value = row[mappedColumnName];
+                                    const formattedValue = evaluateValueFormat(columnFormat, value, locale);
+                                    adjRow[adjDisplayName] = formattedValue;
+                                    chartRow[adjDisplayName] = formatNumberEnabled(columnFormat.valueFormat) ? value : formattedValue;
+                                    htmlRowValues.push(formattedValue);
+                                    [htmlRowStyles, htmlColumnStyles] = processHtmlStyles(formattedValue, adjDisplayName, columnFormat, htmlRowStyles, htmlColumnStyles);
+                                    htmlTransposeColumnStyles = processHtmlTransposeStyles(formattedValue, adjDisplayName, columnFormat, htmlTransposeColumnStyles);
+                                    if (rowIdx === 0) {
+                                        htmlColumnNames.push(adjDisplayName);
+                                    }
+                                    let displayColumnNames = mappedDisplayColumnNames.get(columnFormat.displayName);
+                                    if (!!displayColumnNames) {
+                                        displayColumnNames.add(adjDisplayName);
+                                    }
+                                    else {
+                                        displayColumnNames = new Set([adjDisplayName]);
+                                        mappedDisplayColumnNames.set(columnFormat.displayName, displayColumnNames);
+                                    }
                                 }
                             }
                         }
                     }
                 }
             });
+            adjRows.push(adjRow);
             chartRows.push(chartRow);
             if (rowIdx < DATAGRID_HTML_ROWS) {
                 htmlBuf += buildHtmlRow(htmlRowValues, htmlRowStyles, htmlColumnStyles, DATAGRID_HTML_COLS);
@@ -1334,7 +1383,10 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
             rows = groupAndAggregate(rows, rowGroupCols, [], valueCols);
         }
         rows = sortModel.length > 0 ? sortRows(rows, sortModel) : rows;
-        const visibleColumnState = columnState.filter(column => !column.hide);
+        // We cannot always trust the `hide` field -- we need to look at the row group configuration.
+        const visibleColumnState = columnState.filter(column => !column.hide || // Important: `hide` will be true if we are dealing with a row group.
+            (!!column.rowGroup && column.rowGroupIndex === 0) // We only display the **first** row group.
+        ).sort((a, b) => getColumnSequenceRank(a) - getColumnSequenceRank(b));
         let rowIdx = 0;
         rows.forEach((row) => {
             let adjRow = {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cellaware/utils",
-    "version": "8.11.16",
+    "version": "8.11.18",
     "description": "Cellaware Utilities for Node.js",
     "author": "Cellaware Technologies",
     "type": "module",