@cellaware/utils 8.3.17 → 8.3.18

package/dist/chatwms/datagrid.d.ts

@@ -8,6 +8,7 @@ export interface DatagridStateBase {
 export interface DatagridState extends DatagridStateBase {
     adjRowData: any[];
     chartRowData: any[];
+    html: string;
 }
 export declare function initDatagridState(): DatagridState;
 export type ColumnState = {
@@ -126,8 +127,4 @@ export declare function codifyCondition(condition: DatagridCondition): string;
  */
 export declare function stripNumericValueFormat(value: string | number | undefined): any;
 export declare function transformDatagrid(rows: any[], datagridState: DatagridStateBase, locale: string, condition?: DatagridCondition): DatagridState;
-export declare function datagridToString(datagridState: DatagridState, rowCnt?: number): {
-    html: string;
-    markdown: string;
-};
 export {};

package/dist/chatwms/datagrid.js

@@ -3,7 +3,8 @@ import { CHATWMS_DEFAULT_LANGUAGE } from "./user.js";
 export function initDatagridState() {
     return {
         adjRowData: [],
-        chartRowData: []
+        chartRowData: [],
+        html: ''
     };
 }
 export const DEFAULT_VALUE_FORMAT_VALUE = 'none';
@@ -756,6 +757,61 @@ function sortRows(data, sortModel) {
         return 0;
     });
 }
+function processHtmlStyles(value, columnFormat, rowStyles, columnStyles) {
+    let columnStyle = {
+        columnName: '',
+        styles: []
+    };
+    // Reminder: Value Formatting is performed **before** Conditional Formatting.
+    // https://chatwms.io/user-manual/concepts/column-formatting#conditional-formatting
+    for (const condFmt of columnFormat.conditionalFormats.slice().reverse()) {
+        // `conditionalFormats` has already been sorted by `sequence`.
+        // NOTE: need to reverse the array for sequence to be correctly applied.
+        // NOTE: using `slice` to make shallow copy of array since `reverse` does so in place.
+        if (evaluateConditionalFormat(condFmt, columnFormat.type, formatNumberEnabled(columnFormat.valueFormat) ? stripNumericValueFormat(value) : value)) {
+            if (condFmt.row) {
+                rowStyles.push(condFmt.style);
+            }
+            else {
+                columnStyle.styles.push(condFmt.style);
+            }
+        }
+    }
+    columnStyles.push(columnStyle);
+    return [rowStyles, columnStyles];
+}
+function buildHtmlHeader(columnNames) {
+    let buf = '<table>\n\t<thead>\n\t\t<tr>';
+    for (const columnName of columnNames) {
+        buf += `\n\t\t\t<th>${columnName}</th>`;
+    }
+    buf += '\n\t\t</tr>\n\t</thead>';
+    buf += '\n\t<tbody>';
+    return buf;
+}
+function buildHtmlRow(rowValues, rowStyles, columnStyles) {
+    let buf = '';
+    // Apply row styles.
+    if (rowStyles.length > 0) {
+        buf += `\n\t\t<tr class="${rowStyles.join(' ')}">`;
+    }
+    else {
+        buf += '\n\t\t<tr>';
+    }
+    // Write cell values with styles.
+    let colIdx = 0;
+    for (const rowValue of rowValues) {
+        if (columnStyles[colIdx].styles.length > 0) {
+            buf += `\n\t\t\t<td class="${columnStyles[colIdx].styles.join(' ')}">${rowValue}</td>`;
+        }
+        else {
+            buf += `\n\t\t\t<td>${rowValue}</td>`;
+        }
+        colIdx++;
+    }
+    buf += '\n\t\t</tr>';
+    return buf;
+}
 export function transformDatagrid(rows, datagridState, locale, condition) {
     const columnState = datagridState.columnState ?? [];
     const filterModel = datagridState.filterModel ?? {};
@@ -764,6 +820,8 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
     const { rowGroupCols, pivotCols, valueCols, sortModel } = parseColumnState(columnState);
     rows = filterRows(rows, filterModel);
     const chartRowData = [];
+    let htmlBuf = '';
+    const htmlColumnNames = [];
     // IMPORTANT: we evaluate the datagrid condition AFTER we are done with all transformations.
     // NOTE: we do not need any pivot columns for pivot mode to be valid.
     // https://chatwms.io/user-manual/chatwms/faq#q-do-i-have-to-have-a-group-column-to-just-display-a-count-in-the-datagrid
@@ -773,14 +831,23 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
         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.
+        let rowIdx = 0;
         rows.forEach(row => {
             let chartRow = {};
+            let htmlRowValues = [];
+            let htmlRowStyles = [];
+            let htmlColumnStyles = [];
             columnFormats.forEach(columnFormat => {
                 if (columnFormat.name in row) {
                     const value = row[columnFormat.name];
                     const formattedValue = evaluateValueFormat(columnFormat, row[columnFormat.name], locale);
                     row[columnFormat.displayName] = formattedValue;
                     chartRow[columnFormat.displayName] = formatNumberEnabled(columnFormat.valueFormat) ? value : formattedValue;
+                    htmlRowValues.push(formattedValue);
+                    [htmlRowStyles, htmlColumnStyles] = processHtmlStyles(formattedValue, columnFormat, htmlRowStyles, htmlColumnStyles);
+                    if (rowIdx === 0) {
+                        htmlColumnNames.push(columnFormat.displayName);
+                    }
                     // Remove name in favor of display name.
                     if (columnFormat.displayName !== columnFormat.name) {
                         delete row[columnFormat.name];
@@ -797,6 +864,11 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
                                 const formattedValue = evaluateValueFormat(columnFormat, row[mappedColumnName], locale);
                                 row[adjDisplayName] = formattedValue;
                                 chartRow[adjDisplayName] = formatNumberEnabled(columnFormat.valueFormat) ? value : formattedValue;
+                                htmlRowValues.push(formattedValue);
+                                [htmlRowStyles, htmlColumnStyles] = processHtmlStyles(formattedValue, columnFormat, htmlRowStyles, htmlColumnStyles);
+                                if (rowIdx === 0) {
+                                    htmlColumnNames.push(columnFormat.displayName);
+                                }
                                 // Remove name in favor of display name.
                                 if (adjDisplayName !== mappedColumnName) {
                                     delete row[mappedColumnName];
@@ -815,6 +887,8 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
                 }
             });
             chartRowData.push(chartRow);
+            htmlBuf += buildHtmlRow(htmlRowValues, htmlRowStyles, htmlColumnStyles);
+            rowIdx++;
         });
         if (!!condition) {
             rows = evaluatePivotDatagridCondition(rows, condition, mappedDisplayColumnNames);
@@ -827,8 +901,12 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
         rows = sortModel.length > 0 ? sortRows(rows, sortModel) : rows;
         const hiddenColumnNames = columnState.filter(column => !!column.hide && !column.rowGroup).map(column => column.colId) ?? [];
         const visibleColumnFormats = columnFormats.filter(column => !hiddenColumnNames.includes(column.name)) ?? [];
+        let rowIdx = 0;
         rows.forEach(row => {
             let chartRow = {};
+            let htmlRowValues = [];
+            let htmlRowStyles = [];
+            let htmlColumnStyles = [];
             hiddenColumnNames.forEach(columnName => {
                 delete row[columnName];
             });
@@ -837,124 +915,23 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
                 const formattedValue = evaluateValueFormat(columnFormat, row[columnFormat.name], locale);
                 row[columnFormat.displayName] = formattedValue;
                 chartRow[columnFormat.displayName] = formatNumberEnabled(columnFormat.valueFormat) ? value : formattedValue;
+                htmlRowValues.push(formattedValue);
+                [htmlRowStyles, htmlColumnStyles] = processHtmlStyles(formattedValue, columnFormat, htmlRowStyles, htmlColumnStyles);
+                if (rowIdx === 0) {
+                    htmlColumnNames.push(columnFormat.displayName);
+                }
                 // Remove name in favor of display name.
                 if (columnFormat.displayName !== columnFormat.name) {
                     delete row[columnFormat.name];
                 }
             });
             chartRowData.push(chartRow);
+            htmlBuf += buildHtmlRow(htmlRowValues, htmlRowStyles, htmlColumnStyles);
+            rowIdx++;
         });
         if (!!condition) {
             rows = evaluateDatagridCondition(rows, condition);
         }
     }
-    return { ...datagridState, adjRowData: rows, chartRowData };
-}
-export function datagridToString(datagridState, rowCnt) {
-    let htmlBuf = '';
-    let markdownBuf = '';
-    if (datagridState.adjRowData.length === 0) {
-        return {
-            html: htmlBuf,
-            markdown: markdownBuf
-        };
-    }
-    const columnFormats = datagridState.columnFormats ?? [];
-    if (columnFormats.length === 0) {
-        return {
-            html: htmlBuf,
-            markdown: markdownBuf
-        };
-    }
-    const totalRowCnt = datagridState.adjRowData.length;
-    rowCnt = rowCnt ?? totalRowCnt;
-    if (rowCnt < totalRowCnt) {
-        const message = `Displaying the first ${rowCnt} rows.`;
-        htmlBuf += `<p style="font-style: italic;">${message}</p>`;
-        markdownBuf += `\n*${message}*\n\n`;
-    }
-    // Header:
-    htmlBuf += '<table>\n\t<thead>\n\t\t<tr>';
-    let columns = [];
-    for (const key in datagridState.adjRowData[0]) {
-        columns.push(key);
-        htmlBuf += `\n\t\t\t<th>${key}</th>`;
-        markdownBuf += `| ${key} `;
-    }
-    markdownBuf += '|\n';
-    for (const _ of columns) {
-        markdownBuf += `| ----- `;
-    }
-    markdownBuf += '|\n';
-    htmlBuf += '\n\t\t</tr>\n\t</thead>';
-    // Rows:
-    htmlBuf += '\n\t<tbody>';
-    let rowIdx = 0;
-    for (const row of datagridState.adjRowData) {
-        if (rowIdx >= rowCnt) {
-            break;
-        }
-        let colIdx = 0;
-        const rowStyles = [];
-        const colStyles = [];
-        let cellValues = [];
-        // Extract cell values and row/column styles first, then write to html & markdown.
-        for (const key in row) {
-            let val = row[key];
-            if (val instanceof Date) {
-                const dteStr = val.toISOString();
-                val = dteStr.substring(0, dteStr.lastIndexOf('.'));
-            }
-            cellValues.push(val);
-            let colStyle = {
-                columnName: '',
-                styles: []
-            };
-            // Reminder: Value Formatting is performed **before** Conditional Formatting.
-            // https://chatwms.io/user-manual/concepts/column-formatting#conditional-formatting
-            const colFmt = columnFormats[colIdx];
-            for (const condFmt of colFmt.conditionalFormats.slice().reverse()) {
-                // `conditionalFormats` has already been sorted by `sequence`.
-                // NOTE: need to reverse the array for sequence to be correctly applied.
-                // NOTE: using `slice` to make shallow copy of array since `reverse` does so in place.
-                if (evaluateConditionalFormat(condFmt, colFmt.type, formatNumberEnabled(colFmt.valueFormat) ? stripNumericValueFormat(val) : val)) {
-                    if (condFmt.row) {
-                        rowStyles.push(condFmt.style);
-                    }
-                    else {
-                        colStyle.styles.push(condFmt.style);
-                    }
-                }
-            }
-            colStyles.push(colStyle);
-            colIdx++;
-        }
-        // Apply row styles.
-        if (rowStyles.length > 0) {
-            htmlBuf += `\n\t\t<tr class="${rowStyles.join(' ')}">`;
-        }
-        else {
-            htmlBuf += '\n\t\t<tr>';
-        }
-        // Write cell values with styles.
-        colIdx = 0;
-        for (const rowValue of cellValues) {
-            if (colStyles[colIdx].styles.length > 0) {
-                htmlBuf += `\n\t\t\t<td class="${colStyles[colIdx].styles.join(' ')}">${rowValue}</td>`;
-            }
-            else {
-                htmlBuf += `\n\t\t\t<td>${rowValue}</td>`;
-            }
-            markdownBuf += `| ${rowValue} `;
-            colIdx++;
-        }
-        htmlBuf += '\n\t\t</tr>';
-        markdownBuf += '|\n';
-        rowIdx++;
-    }
-    htmlBuf += '\n\t</tbody>\n</table>';
-    return {
-        html: htmlBuf,
-        markdown: markdownBuf
-    };
+    return { ...datagridState, adjRowData: rows, chartRowData, html: `${buildHtmlHeader(htmlColumnNames)}${htmlBuf}` };
 }

package/package.json

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