@cellaware/utils 8.1.12 → 8.2.1

package/dist/chatwms/datagrid.d.ts

@@ -116,6 +116,7 @@ export interface DatagridCondition {
 }
 export declare function initDatagridCondition(): DatagridCondition;
 export declare function summarizeCondition(condition: DatagridCondition, localeMessageFn: (language: string, messageId: string) => Promise<string>): Promise<string>;
+export declare function summarizeConditionAsMarkdown(condition: DatagridCondition, localeMessageFn: (language: string, messageId: string) => Promise<string>): Promise<string>;
 export declare function codifyCondition(condition: DatagridCondition): string;
 /**
  * Equivalent of `parseNumeric` in front end
@@ -124,5 +125,8 @@ 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 datagridToHtml(datagridState: DatagridState): string;
+export declare function datagridToString(datagridState: DatagridState): {
+    html: string;
+    markdown: string;
+};
 export {};

package/dist/chatwms/datagrid.js

@@ -286,6 +286,27 @@ export async function summarizeCondition(condition, localeMessageFn) {
     }
     return `${condition.columnName} ${ruleStr}`;
 }
+export async function summarizeConditionAsMarkdown(condition, localeMessageFn) {
+    let ruleStr = '';
+    switch (condition.rule) {
+        case ConditionalFormatRule.BETWEEN:
+            ruleStr = `**${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}** ${condition.value} **${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, 'conditional-format-rule-and')}** ${condition.value2}`;
+            break;
+        case ConditionalFormatRule.BLANK:
+        case ConditionalFormatRule.NOT_BLANK:
+            ruleStr = `**${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}**`;
+            break;
+        default:
+            if (condition.dataType === 'text') {
+                ruleStr = `**${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}** '${condition.value}'`;
+            }
+            else {
+                ruleStr = `**${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}** ${condition.value}`;
+            }
+            break;
+    }
+    return `\`${condition.columnName}\` ${ruleStr}`;
+}
 export function codifyCondition(condition) {
     // NOTE: since we check for action/unsafe SQL with every query, we do not need to check for SQL injection here.
     if (condition.dataType === 'number') {
@@ -723,6 +744,8 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
     rows = filterRows(rows, filterModel);
     const chartRowData = [];
     // 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
     if (isPivotMode && valueCols.length > 0) {
         const pivotOutput = pivotData(rows, rowGroupCols, pivotCols, valueCols);
         rows = pivotOutput.rows;
@@ -806,32 +829,45 @@ export function transformDatagrid(rows, datagridState, locale, condition) {
     }
     return { ...datagridState, adjRowData: rows, chartRowData };
 }
-export function datagridToHtml(datagridState) {
-    let buf = '';
+export function datagridToString(datagridState) {
+    let htmlBuf = '';
+    let markdownBuf = '';
     if (datagridState.adjRowData.length === 0) {
-        return buf;
+        return {
+            html: htmlBuf,
+            markdown: markdownBuf
+        };
     }
     const columnFormats = datagridState.columnFormats ?? [];
     if (columnFormats.length === 0) {
-        return buf;
+        return {
+            html: htmlBuf,
+            markdown: markdownBuf
+        };
     }
     // Header:
-    buf += '<table>\n\t<thead>\n\t\t<tr>';
+    htmlBuf += '<table>\n\t<thead>\n\t\t<tr>';
     let columns = [];
     for (const key in datagridState.adjRowData[0]) {
         columns.push(key);
-        buf += `\n\t\t\t<th>${key}</th>`;
+        htmlBuf += `\n\t\t\t<th>${key}</th>`;
+        markdownBuf += `| ${key} `;
+    }
+    markdownBuf += '|\n';
+    for (const _ of columns) {
+        markdownBuf += `| ----- `;
     }
-    buf += '\n\t\t</tr>\n\t</thead>';
+    markdownBuf += '|\n';
+    htmlBuf += '\n\t\t</tr>\n\t</thead>';
     // Rows:
-    buf += '\n\t<tbody>';
+    htmlBuf += '\n\t<tbody>';
     let rowIdx = 0;
     for (const row of datagridState.adjRowData) {
         let colIdx = 0;
         const rowStyles = [];
         const colStyles = [];
         let cellValues = [];
-        // Extract cell values and row/column styles first, then write to html.
+        // 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) {
@@ -864,25 +900,30 @@ export function datagridToHtml(datagridState) {
         }
         // Apply row styles.
         if (rowStyles.length > 0) {
-            buf += `\n\t\t<tr class="${rowStyles.join(' ')}">`;
+            htmlBuf += `\n\t\t<tr class="${rowStyles.join(' ')}">`;
         }
         else {
-            buf += '\n\t\t<tr>';
+            htmlBuf += '\n\t\t<tr>';
         }
         // Write cell values with styles.
         colIdx = 0;
         for (const rowValue of cellValues) {
             if (colStyles[colIdx].styles.length > 0) {
-                buf += `\n\t\t\t<td class="${colStyles[colIdx].styles.join(' ')}">${rowValue}</td>`;
+                htmlBuf += `\n\t\t\t<td class="${colStyles[colIdx].styles.join(' ')}">${rowValue}</td>`;
             }
             else {
-                buf += `\n\t\t\t<td>${rowValue}</td>`;
+                htmlBuf += `\n\t\t\t<td>${rowValue}</td>`;
             }
+            markdownBuf += `| ${rowValue} `;
             colIdx++;
         }
-        buf += '\n\t\t</tr>';
+        htmlBuf += '\n\t\t</tr>';
+        markdownBuf += '|\n';
         rowIdx++;
     }
-    buf += '\n\t</tbody>\n</table>';
-    return buf;
+    htmlBuf += '\n\t</tbody>\n</table>';
+    return {
+        html: htmlBuf,
+        markdown: markdownBuf
+    };
 }

package/package.json

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